Interface ChestGUI
- All Known Subinterfaces:
PagedGUI<T>
public interface ChestGUI
箱子GUI接口 - 定义箱子类型图形用户界面的标准API
- Since:
- 1.0.0
- Version:
- 1.0.0
- Author:
- Berry_so
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddClickListener(GUIClickListener listener) 添加点击监听器voidaddCloseListener(GUICloseListener listener) 添加关闭监听器default voidclear()清空GUI中的所有物品voidclearPlaceholders(int slot) 清除指定槽位的所有占位符default voidclearSlot(int slot) 清空指定槽位voidclose(org.bukkit.entity.Player player) 关闭GUIbooleancontainsPlaceholder(int slot, String... placeholders) 检查指定槽位是否包含特定占位符voiddestroy()销毁GUI,释放资源org.bukkit.inventory.ItemStack[]获取GUI内容数组getGUIId()获取GUI的唯一标识符org.bukkit.inventory.ItemStackgetItem(int slot) 获取指定位置的物品getPlaceholders(int slot) 获取指定槽位的所有占位符intgetSize()获取GUI大小(行数)getTitle()获取GUI标题Set<org.bukkit.entity.Player> 获取当前查看此GUI的所有玩家booleanhasPlaceholders(int slot) 检查指定槽位是否有占位符boolean检查是否允许玩家背包交互boolean检查GUI是否已被销毁default booleanisOpen(org.bukkit.entity.Player player) 检查指定玩家是否正在查看此GUIvoidopen(org.bukkit.entity.Player player) 打开GUI给指定玩家voidrefresh(org.bukkit.entity.Player player) 刷新GUIvoidregisterPlaceholders(int slot, String... placeholders) 为指定槽位注册占位符voidremoveClickListener(GUIClickListener listener) 移除点击监听器voidremoveCloseListener(GUICloseListener listener) 移除关闭监听器voidsetAllowPlayerInventoryInteraction(boolean allow) 设置是否允许玩家取出物品voidsetContents(org.bukkit.inventory.ItemStack[] items) 设置GUI内容voidsetItem(int slot, org.bukkit.inventory.ItemStack item) 设置指定位置的物品voidsetPlaceholderValues(int slot, String... values) 设置指定槽位的占位符值voidsetPlaceholderValues(int slot, SmartString... values) 设置指定槽位的占位符值voidupdateTitle(SmartString newTitle) 更新GUI标题
-
Method Details
-
getGUIId
-
getTitle
-
getSize
int getSize()获取GUI大小(行数)- Returns:
- GUI行数(1-6)
-
setItem
void setItem(int slot, org.bukkit.inventory.ItemStack item) 设置指定位置的物品- Parameters:
slot- 槽位索引item- 要设置的物品
-
getItem
org.bukkit.inventory.ItemStack getItem(int slot) 获取指定位置的物品- Parameters:
slot- 槽位索引- Returns:
- 指定槽位的物品,如果为空则返回null
-
open
void open(org.bukkit.entity.Player player) 打开GUI给指定玩家- Parameters:
player- 目标玩家
-
close
void close(org.bukkit.entity.Player player) 关闭GUI- Parameters:
player- 目标玩家
-
refresh
void refresh(org.bukkit.entity.Player player) 刷新GUI- Parameters:
player- 目标玩家
-
addClickListener
-
removeClickListener
-
addCloseListener
-
setAllowPlayerInventoryInteraction
void setAllowPlayerInventoryInteraction(boolean allow) 设置是否允许玩家取出物品- Parameters:
allow- true表示允许,false表示禁止
-
getViewers
-
destroy
void destroy()销毁GUI,释放资源 -
getContents
org.bukkit.inventory.ItemStack[] getContents()获取GUI内容数组- Returns:
- GUI中所有物品的数组
-
setContents
void setContents(org.bukkit.inventory.ItemStack[] items) 设置GUI内容- Parameters:
items- 物品数组
-
removeCloseListener
-
isAllowPlayerInventoryInteraction
boolean isAllowPlayerInventoryInteraction()检查是否允许玩家背包交互- Returns:
- true表示允许,false表示禁止
-
isDestroyed
boolean isDestroyed()检查GUI是否已被销毁- Returns:
- true表示已销毁,false表示未销毁
-
updateTitle
-
registerPlaceholders
为指定槽位注册占位符- Parameters:
slot- 槽位索引placeholders- 占位符名称数组
-
setPlaceholderValues
设置指定槽位的占位符值- Parameters:
slot- 槽位索引values- 占位符值数组
-
setPlaceholderValues
设置指定槽位的占位符值- Parameters:
slot- 槽位索引values- 占位符值数组
-
clearPlaceholders
void clearPlaceholders(int slot) 清除指定槽位的所有占位符- Parameters:
slot- 槽位索引
-
getPlaceholders
-
containsPlaceholder
检查指定槽位是否包含特定占位符- Parameters:
slot- 槽位索引placeholders- 要检查的占位符名称数组- Returns:
- true表示包含所有指定占位符,false表示不包含
-
hasPlaceholders
boolean hasPlaceholders(int slot) 检查指定槽位是否有占位符- Parameters:
slot- 槽位索引- Returns:
- true表示有占位符,false表示没有
-
clearSlot
default void clearSlot(int slot) 清空指定槽位- Parameters:
slot- 槽位索引
-
clear
default void clear()清空GUI中的所有物品 -
isOpen
default boolean isOpen(org.bukkit.entity.Player player) 检查指定玩家是否正在查看此GUI- Parameters:
player- 要检查的玩家- Returns:
- true表示正在查看,false表示未查看
-