Package org.bukkit.help
Interface HelpMap
public interface HelpMap
The HelpMap tracks all help topics registered in a Bukkit server. When the
server starts up or is reloaded, help is processed and topics are added in
the following order:
- General topics are loaded from the help.yml
- Plugins load and optionally call
addTopic()
- Registered plugin commands are processed by
HelpTopicFactory
objects to create topics - Topic contents are amended as directed in help.yml
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a topic to the server's help index.void
clear()
Clears out the contents of the help index.getHelpTopic
(@NotNull String topicName) Returns a help topic for a given topic name.Returns a collection of all the registered help topics.Gets the list of plugins the server administrator has chosen to exclude from the help index.void
registerHelpTopicFactory
(@NotNull Class<?> commandClass, @NotNull HelpTopicFactory<?> factory) Associates aHelpTopicFactory
object with given command base class.
-
Method Details
-
getHelpTopic
Returns a help topic for a given topic name.- Parameters:
topicName
- The help topic name to look up.- Returns:
- A
HelpTopic
object matching the topic name or null if none can be found.
-
getHelpTopics
Returns a collection of all the registered help topics.- Returns:
- All the registered help topics.
-
addTopic
Adds a topic to the server's help index.- Parameters:
topic
- The new help topic to add.
-
clear
void clear()Clears out the contents of the help index. Normally called during server reload. -
registerHelpTopicFactory
void registerHelpTopicFactory(@NotNull @NotNull Class<?> commandClass, @NotNull @NotNull HelpTopicFactory<?> factory) Associates aHelpTopicFactory
object with given command base class. Plugins typically call this method duringonLoad()
. Once registered, the custom HelpTopicFactory will be used to create a customHelpTopic
for all commands deriving from thecommandClass
base class, or all commands deriving fromPluginCommand
who's executor derives fromcommandClass
base class.- Parameters:
commandClass
- The class for which the custom HelpTopicFactory applies. Must derive from eitherCommand
orCommandExecutor
.factory
- TheHelpTopicFactory
implementation to associate with thecommandClass
.- Throws:
IllegalArgumentException
- Thrown ifcommandClass
does not derive from a legal base class.
-
getIgnoredPlugins
Gets the list of plugins the server administrator has chosen to exclude from the help index. Plugin authors who choose to directly extendCommand
instead ofPluginCommand
will need to check this collection in theirHelpTopicFactory
implementations to ensure they meet the server administrator's expectations.- Returns:
- A list of plugins that should be excluded from the help index.
-