public class IndexHelpTopic extends HelpTopic
If a preamble is provided to the constructor, that text will be displayed before the first item in the index.
Modifier and Type | Field | Description |
---|---|---|
protected Collection<HelpTopic> |
allTopics |
|
protected String |
permission |
|
protected String |
preamble |
amendedPermission, fullText, name, shortText
Constructor | Description |
---|---|
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) |
Modifier and Type | Method | Description |
---|---|---|
void |
amendCanSee(@Nullable String amendedPermission) |
Allows the server administrator to override the permission required to
see a help topic.
|
protected @NotNull String |
buildIndexLine(@NotNull CommandSender sender,
@NotNull HelpTopic topic) |
Builds individual lines in the index topic.
|
protected @NotNull String |
buildPreamble(@NotNull CommandSender sender) |
Builds the topic preamble.
|
boolean |
canSee(@NotNull CommandSender sender) |
Determines if a
Player is allowed to see this help topic. |
@NotNull String |
getFullText(@NotNull CommandSender sender) |
Returns the full description of this help topic that is displayed when
the user requests this topic's details.
|
protected void |
setTopicsCollection(@NotNull Collection<HelpTopic> topics) |
Sets the contents of the internal allTopics collection.
|
amendTopic, applyAmendment, getName, getShortText
protected String permission
protected String preamble
protected Collection<HelpTopic> allTopics
public IndexHelpTopic(@NotNull @NotNull String name, @Nullable @Nullable String shortText, @Nullable @Nullable String permission, @NotNull @NotNull Collection<HelpTopic> topics)
protected void setTopicsCollection(@NotNull @NotNull Collection<HelpTopic> topics)
topics
- The topics to set.public boolean canSee(@NotNull @NotNull CommandSender sender)
HelpTopic
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.
public void amendCanSee(@Nullable @Nullable String amendedPermission)
HelpTopic
HelpTopic implementations should take this into account when
determining topic visibility on the HelpTopic.canSee(org.bukkit.command.CommandSender)
function.
amendCanSee
in class HelpTopic
amendedPermission
- The permission node the server administrator
wishes to apply to this topic.@NotNull public @NotNull String getFullText(@NotNull @NotNull CommandSender sender)
HelpTopic
The result will be paginated to properly fit the user's client.
getFullText
in class HelpTopic
sender
- The player or console requesting the full text. Useful
for further security trimming the command's full text based on
sub-permissions in custom implementations.@NotNull protected @NotNull String buildPreamble(@NotNull @NotNull CommandSender sender)
sender
- The command sender requesting the preamble.@NotNull protected @NotNull String buildIndexLine(@NotNull @NotNull CommandSender sender, @NotNull @NotNull HelpTopic topic)
sender
- The command sender requesting the index line.topic
- The topic to render into an index line.Copyright © 2020. All rights reserved.