程序包 org.bukkit.help

类 IndexHelpTopic

java.lang.Object

org.bukkit.help.HelpTopic

org.bukkit.help.IndexHelpTopic

public class IndexHelpTopic
extends HelpTopic

此帮助主题生成其他帮助主题的列表. 此类对于添加自己的索引帮助主题很有用. 要强制特定顺序, 请使用排序集合.

如果向构造函数提供了前言文本, 该文本将在索引中的第一项之前显示.

字段概要

字段

修饰符和类型	字段	说明
protected Collection<HelpTopic>	allTopics
protected String	permission
protected String	preamble

从类继承的字段 org.bukkit.help.HelpTopic

amendedPermission, fullText, name, shortText

构造器概要

构造器

构造器	说明
IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics)
IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics, @Nullable String preamble)

方法概要

修饰符和类型	方法	说明
void	amendCanSee(@Nullable String amendedPermission)	允许服务器管理员覆盖查看帮助主题所需的权限.
protected @NotNull String	buildIndexLine(@NotNull CommandSender sender, @NotNull HelpTopic topic)	构建索引主题中的每一行.
protected @NotNull String	buildPreamble(@NotNull CommandSender sender)	构建主题前言.
boolean	canSee(@NotNull CommandSender sender)	确定Player是否被允许查看此帮助主题.
@NotNull String	getFullText(@NotNull CommandSender sender)	返回当用户请求此主题详情时显示的完整帮助主题描述.
protected void	setTopicsCollection(@NotNull Collection<HelpTopic> topics)	设置内部allTopics集合的内容.

从类继承的方法 org.bukkit.help.HelpTopic

amendTopic, applyAmendment, getName, getShortText

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

permission

protected String permission

preamble

protected String preamble

allTopics

protected Collection<HelpTopic> allTopics

构造器详细资料

IndexHelpTopic

public IndexHelpTopic(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String shortText,
 @Nullable
 @Nullable String permission,
 @NotNull
 @NotNull Collection<HelpTopic> topics)

IndexHelpTopic

public IndexHelpTopic(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String shortText,
 @Nullable
 @Nullable String permission,
 @NotNull
 @NotNull Collection<HelpTopic> topics,
 @Nullable
 @Nullable String preamble)

方法详细资料

setTopicsCollection

protected void setTopicsCollection(@NotNull
 @NotNull Collection<HelpTopic> topics)

设置内部allTopics集合的内容.

原文： Sets the contents of the internal allTopics collection.

参数:

topics - 要设置的主题.

canSee

public boolean canSee(@NotNull
 @NotNull CommandSender sender)

从类复制的说明: HelpTopic

确定Player是否被允许查看此帮助主题.

HelpTopic实现在确定主题可见性时应考虑服务器管理员通过HelpTopic.amendCanSee(String)函数设置的意愿.

原文： Determines if a Player is allowed to see this help topic.

HelpTopic implementations should take server administrator wishes into account as set by the HelpTopic.amendCanSee(String) function.

指定者:

canSee 在类中 HelpTopic

参数:

sender - 相关的Player.

返回:

如果Player可以看到此帮助主题则为True, 否则为false.

amendCanSee

public void amendCanSee(@Nullable
 @Nullable String amendedPermission)

从类复制的说明: HelpTopic

允许服务器管理员覆盖查看帮助主题所需的权限.

HelpTopic实现在HelpTopic.canSee(org.bukkit.command.CommandSender)函数中确定主题可见性时应考虑这一点.

原文： Allows the server administrator to override the permission required to see a help topic.

HelpTopic implementations should take this into account when determining topic visibility on the HelpTopic.canSee(org.bukkit.command.CommandSender) function.

覆盖:

amendCanSee 在类中 HelpTopic

参数:

amendedPermission - 服务器管理员希望应用于此主题的权限节点.

getFullText

@NotNull
public @NotNull String getFullText(@NotNull
 @NotNull CommandSender sender)

从类复制的说明: HelpTopic

返回当用户请求此主题详情时显示的完整帮助主题描述.

结果将被分页以适当适应用户的客户端.

原文： Returns the full description of this help topic that is displayed when the user requests this topic's details.

The result will be paginated to properly fit the user's client.

覆盖:

getFullText 在类中 HelpTopic

参数:

sender - 请求完整文本的玩家或控制台. 对于在自定义实现中基于子权限进一步安全裁剪命令完整文本很有用.

返回:

完整的主题描述.

buildPreamble

@NotNull
protected @NotNull String buildPreamble(@NotNull
 @NotNull CommandSender sender)

构建主题前言. 重写此方法可更改索引前言的外观.

原文: Builds the topic preamble. Override this method to change how the index preamble looks.

参数:

sender - 请求前言的命令发送者

返回:

主题前言

buildIndexLine

@NotNull
protected @NotNull String buildIndexLine(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull HelpTopic topic)

构建索引主题中的每一行. 重写此方法可更改索引行的渲染方式.

原文: Builds individual lines in the index topic. Override this method to change how index lines are rendered.

参数:

sender - 请求索引行的命令发送者

topic - 要渲染为索引行的主题

返回:

渲染后的索引行