org.bukkit.help

クラス HelpTopic

java.lang.Object

org.bukkit.help.HelpTopic

直系の既知のサブクラス:

GenericCommandHelpTopic, IndexHelpTopic

public abstract class HelpTopic
extends Object

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.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	amendedPermission
protected String	fullText
protected String	name
protected String	shortText

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HelpTopic()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	amendCanSee(String amendedPermission) Allows the server administrator to override the permission required to see a help topic.
void	amendTopic(String amendedShortText, String amendedFullText) Allows the server admin (or another plugin) to add or replace the contents of a help topic.
protected String	applyAmendment(String baseText, String amendment) Developers implementing their own custom HelpTopic implementations can use this utility method to ensure their implementations comply with the expected behavior of the amendTopic(String, String) method.
abstract boolean	canSee(CommandSender player) Determines if a Player is allowed to see this help topic.
String	getFullText(CommandSender forWho) Returns the full description of this help topic that is displayed when the user requests this topic's details.
String	getName() Returns the name of this help topic.
String	getShortText() Returns a brief description that will be displayed in the topic index.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

name

protected String name

shortText

protected String shortText

fullText

protected String fullText

amendedPermission

protected String amendedPermission

コンストラクタの詳細

HelpTopic

public HelpTopic()

メソッドの詳細

canSee

public abstract boolean canSee(CommandSender player)

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

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

パラメータ:

player - The Player in question.

戻り値:

True of the Player can see this help topic, false otherwise.

amendCanSee

public void amendCanSee(String amendedPermission)

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 canSee(org.bukkit.command.CommandSender) function.

パラメータ:

amendedPermission - The permission node the server administrator wishes to apply to this topic.

getName

public String getName()

Returns the name of this help topic.

戻り値:

The topic name.

getShortText

public String getShortText()

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

戻り値:

A brief topic description.

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.

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

パラメータ:

forWho - 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.

戻り値:

A full topic description.

amendTopic

public void amendTopic(String amendedShortText,
                       String amendedFullText)

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

A null in either parameter will leave that part of the topic unchanged. In either amending parameter, the string <text> is replaced with the existing contents in the help topic. Use this to append or prepend additional content into an automatically generated help topic.

パラメータ:

amendedShortText - The new topic short text to use, or null to leave alone.

amendedFullText - The new topic full text to use, or null to leave alone.

applyAmendment

protected String applyAmendment(String baseText,
                                String amendment)

Developers implementing their own custom HelpTopic implementations can use this utility method to ensure their implementations comply with the expected behavior of the amendTopic(String, String) method.

パラメータ:

baseText - The existing text of the help topic.

amendment - The amending text from the amendTopic() method.

戻り値:

The application of the amending text to the existing text, according to the expected rules of amendTopic().