Classes dedicated to facilitate direct player-to-plugin communication.
Interface Summary Interface Description ConversableThe Conversable interface is used to indicate objects that can have conversations. ConversationAbandonedListener ConversationCancellerA ConversationCanceller is a class that cancels an active
ConversationPrefixA ConversationPrefix implementation prepends all output from the conversation to the player. PromptA Prompt is the main constituent of a
Class Summary Class Description BooleanPromptBooleanPrompt is the base class for any prompt that requires a boolean response from the user. ConversationThe 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. ConversationAbandonedEventConversationAbandonedEvent contains information about an abandoned conversation. ConversationContextA 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
ConversationFactoryA ConversationFactory is responsible for creating a
Conversationfrom a predefined template.
ExactMatchConversationCancellerAn ExactMatchConversationCanceller cancels a conversation if the user enters an exact input string FixedSetPromptFixedSetPrompt is the base class for any prompt that requires a fixed set response from the user. InactivityConversationCancellerAn InactivityConversationCanceller will cancel a
Conversationafter a period of inactivity by the user.
ManuallyAbandonedConversationCancellerThe ManuallyAbandonedConversationCanceller is only used as part of a
ConversationAbandonedEventto indicate that the conversation was manually abandoned by programmatically calling the abandon() method on it.
MessagePromptMessagePrompt is the base class for any prompt that only displays a message to the user and requires no input. NullConversationPrefixNullConversationPrefix is a
ConversationPrefiximplementation that displays nothing in front of conversation output.
NumericPromptNumericPrompt is the base class for any prompt that requires a
Numberresponse from the user.
PlayerNamePromptPlayerNamePrompt is the base class for any prompt that requires the player to enter another player's name. PluginNameConversationPrefixPluginNameConversationPrefix is a
ConversationPrefiximplementation that displays the plugin name in front of conversation output.
RegexPromptRegexPrompt is the base class for any prompt that requires an input validated by a regular expression. StringPromptStringPrompt is the base class for any prompt that accepts an arbitrary string from the user. ValidatingPromptValidatingPrompt is the base class for any prompt that requires validation.
Enum Summary Enum Description Conversation.ConversationState