Uses of Class
org.bukkit.help.HelpTopic
Package | Description |
---|---|
org.bukkit.command.defaults |
Commands for emulating the Minecraft commands and other necessary ones for
use by a Bukkit implementation.
|
org.bukkit.help |
Classes used to manipulate the default command and topic assistance system.
|
-
Uses of HelpTopic in org.bukkit.command.defaults
Methods in org.bukkit.command.defaults that return HelpTopic Modifier and Type Method Description protected HelpTopic
HelpCommand. findPossibleMatches(String searchString)
-
Uses of HelpTopic in org.bukkit.help
Subclasses of HelpTopic in org.bukkit.help Modifier and Type Class Description class
GenericCommandHelpTopic
Lacking an alternative, the help system will create instances of GenericCommandHelpTopic for each command in the server's CommandMap.class
IndexHelpTopic
This help topic generates a list of other help topics.Fields in org.bukkit.help with type parameters of type HelpTopic Modifier and Type Field Description protected Collection<HelpTopic>
IndexHelpTopic. allTopics
Methods in org.bukkit.help that return HelpTopic Modifier and Type Method Description HelpTopic
HelpTopicFactory. createTopic(TCommand command)
This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it.HelpTopic
HelpMap. getHelpTopic(String topicName)
Returns a help topic for a given topic name.Methods in org.bukkit.help that return types with arguments of type HelpTopic Modifier and Type Method Description Collection<HelpTopic>
HelpMap. getHelpTopics()
Returns a collection of all the registered help topics.Methods in org.bukkit.help with parameters of type HelpTopic Modifier and Type Method Description void
HelpMap. addTopic(HelpTopic topic)
Adds a topic to the server's help index.protected String
IndexHelpTopic. buildIndexLine(CommandSender sender, HelpTopic topic)
Builds individual lines in the index topic.int
HelpTopicComparator. compare(HelpTopic lhs, HelpTopic rhs)
Method parameters in org.bukkit.help with type arguments of type HelpTopic Modifier and Type Method Description protected void
IndexHelpTopic. setTopicsCollection(Collection<HelpTopic> topics)
Sets the contents of the internal allTopics collection.Constructor parameters in org.bukkit.help with type arguments of type HelpTopic Constructor Description IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics)
IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics, String preamble)