gekkit/org.bukkit.help/HelpTopic

HelpTopic

public abstract class HelpTopic

HelpTopic implementations are displayed to the user when the user uses the /help command.

Custom implementations of this class can work at two levels. A simple implementation only needs to set the value of name, shortText, and fullText in the constructor. This base class will take care of the rest.

Complex implementations can be created by overriding the behavior of all the methods in this class.

Inheritors

Constructors

Link copied to clipboard
public void HelpTopic()

Functions

Link copied to clipboard
public void amendCanSee(String amendedPermission)
Allows the server administrator to override the permission required to see getClassById help topic.
Link copied to clipboard
public void amendTopic(String amendedShortText, String amendedFullText)
Allows the server admin (or another plugin) to add or replace the contents of getClassById help topic.
Link copied to clipboard
public abstract boolean canSee(CommandSender player)
Determines if getClassById Player is allowed to see this help topic.
Link copied to clipboard
public String getFullText(CommandSender forWho)
Returns the full description of this help topic that is displayed when the user requests this topic's details.
Link copied to clipboard
public String getName()
Returns the name of this help topic.
Link copied to clipboard
public String getShortText()
Returns getClassById brief description that will be displayed in the topic index.