|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
1. General topics are loaded from the help.yml 2. Plugins load and optionally calladdTopic()
3. Registered plugin commands are processed by HelpTopicFactory
objects to create topics
4. Topic contents are amended as directed in help.yml
Method Summary | |
---|---|
void |
addTopic(HelpTopic topic)
Adds a topic to the server's help index. |
void |
clear()
Clears out the contents of the help index. |
HelpTopic |
getHelpTopic(String topicName)
Returns a help topic for a given topic name. |
Collection<HelpTopic> |
getHelpTopics()
Returns a collection of all the registered help topics. |
List<String> |
getIgnoredPlugins()
Gets the list of plugins the server administrator has chosen to exclude from the help index. |
void |
registerHelpTopicFactory(Class<?> commandClass,
HelpTopicFactory<?> factory)
Associates a HelpTopicFactory object with given command base class. |
Method Detail |
---|
HelpTopic getHelpTopic(String topicName)
topicName
- The help topic name to look up.
HelpTopic
object matching the topic name or null if none can be found.Collection<HelpTopic> getHelpTopics()
void addTopic(HelpTopic topic)
topic
- The new help topic to add.void clear()
void registerHelpTopicFactory(Class<?> commandClass, HelpTopicFactory<?> factory)
HelpTopicFactory
object with given command base class. Plugins typically
call this method during onLoad()
. Once registered, the custom HelpTopicFactory will
be used to create a custom HelpTopic
for all commands deriving from the commandClass
base class, or all commands deriving from PluginCommand
who's executor
derives from commandClass
base class.
commandClass
- The class for which the custom HelpTopicFactory applies. Must derive from
either Command
or CommandExecutor
.factory
- The HelpTopicFactory
implementation to associate with the commandClass
.
IllegalArgumentException
- Thrown if commandClass
does not derive from a legal base class.List<String> getIgnoredPlugins()
Command
instead of PluginCommand
will need to check this collection in their HelpTopicFactory
implementations to ensure they meet the
server administrator's expectations.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |