Classes dedicated to facilitate direct player-to-plugin communication.
ClassDescriptionBooleanPrompt is the base class for any prompt that requires a boolean response from the user.The Conversable interface is used to indicate objects that can have conversations.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 contains information about an abandoned conversation.A ConversationCanceller is a class that cancels an active
Conversation.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 all
Promptinvocations.A ConversationFactory is responsible for creating a
Conversationfrom a predefined template.A ConversationPrefix implementation prepends all output from the conversation to the player.An ExactMatchConversationCanceller cancels a conversation if the user enters an exact input stringFixedSetPrompt is the base class for any prompt that requires a fixed set response from the user.An InactivityConversationCanceller will cancel a
Conversationafter a period of inactivity by the user.The ManuallyAbandonedConversationCanceller is only used as part of a
ConversationAbandonedEventto indicate that the conversation was manually abandoned by programmatically calling the abandon() method on it.MessagePrompt is the base class for any prompt that only displays a message to the user and requires no input.NullConversationPrefix is a
ConversationPrefiximplementation that displays nothing in front of conversation output.NumericPrompt is the base class for any prompt that requires a
Numberresponse from the user.PlayerNamePrompt is the base class for any prompt that requires the player to enter another player's name.PluginNameConversationPrefix is a
ConversationPrefiximplementation that displays the plugin name in front of conversation output.A Prompt is the main constituent of a
Conversation.RegexPrompt is the base class for any prompt that requires an input validated by a regular expression.StringPrompt is the base class for any prompt that accepts an arbitrary string from the user.ValidatingPrompt is the base class for any prompt that requires validation.