Package org.bukkit.conversations
Classes dedicated to facilitate direct player-to-plugin communication.
-
Interface Summary Interface Description Conversable The Conversable interface is used to indicate objects that can have conversations.ConversationAbandonedListener ConversationCanceller A ConversationCanceller is a class that cancels an activeConversation
.ConversationPrefix A ConversationPrefix implementation prepends all output from the conversation to the player.Prompt A Prompt is the main constituent of aConversation
. -
Class Summary Class Description BooleanPrompt BooleanPrompt is the base class for any prompt that requires a boolean response from the user.Conversation The Conversation class is responsible for tracking the current state of a conversation, displaying prompts to the user, and dispatching the user's response to the appropriate place.ConversationAbandonedEvent ConversationAbandonedEvent contains information about an abandoned conversation.ConversationContext A ConversationContext provides continuity between nodes in the prompt graph by giving the developer access to the subject of the conversation and a generic map for storing values that are shared between allPrompt
invocations.ConversationFactory A ConversationFactory is responsible for creating aConversation
from a predefined template.ExactMatchConversationCanceller An ExactMatchConversationCanceller cancels a conversation if the user enters an exact input stringFixedSetPrompt FixedSetPrompt is the base class for any prompt that requires a fixed set response from the user.InactivityConversationCanceller An InactivityConversationCanceller will cancel aConversation
after a period of inactivity by the user.ManuallyAbandonedConversationCanceller The ManuallyAbandonedConversationCanceller is only used as part of aConversationAbandonedEvent
to indicate that the conversation was manually abandoned by programmatically calling the abandon() method on it.MessagePrompt MessagePrompt is the base class for any prompt that only displays a message to the user and requires no input.NullConversationPrefix NullConversationPrefix is aConversationPrefix
implementation that displays nothing in front of conversation output.NumericPrompt NumericPrompt is the base class for any prompt that requires aNumber
response from the user.PlayerNamePrompt PlayerNamePrompt is the base class for any prompt that requires the player to enter another player's name.PluginNameConversationPrefix PluginNameConversationPrefix is aConversationPrefix
implementation that displays the plugin name in front of conversation output.RegexPrompt RegexPrompt is the base class for any prompt that requires an input validated by a regular expression.StringPrompt StringPrompt is the base class for any prompt that accepts an arbitrary string from the user.ValidatingPrompt ValidatingPrompt is the base class for any prompt that requires validation. -
Enum Summary Enum Description Conversation.ConversationState