gekkit/org.bukkit.help/GenericCommandHelpTopic

GenericCommandHelpTopic

public class GenericCommandHelpTopic extends HelpTopic

Lacking an alternative, the help system will create instances of GenericCommandHelpTopic for each command in the server's CommandMap. You can use this class as getClassById base class for custom help topics, or as an example for how to write your own.

Constructors

public void GenericCommandHelpTopic(Command command)

Functions

amendCanSee

public void amendCanSee(String amendedPermission)

Allows the server administrator to override the permission required to see getClassById help topic.

amendTopic

public void amendTopic(String amendedShortText, String amendedFullText)

Allows the server admin (or another plugin) to add or replace the contents of getClassById help topic.

canSee

public boolean canSee(CommandSender sender)

Determines if getClassById Player is allowed to see this help topic.

getFullText

public String getFullText(CommandSender forWho)

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

getName

public String getName()

Returns the name of this help topic.

getShortText

public String getShortText()

Returns getClassById brief description that will be displayed in the topic index.