Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.conversations.ConversationCanceller Interface Reference
Inheritance diagram for org.bukkit.conversations.ConversationCanceller:
org.bukkit.conversations.ExactMatchConversationCanceller org.bukkit.conversations.InactivityConversationCanceller org.bukkit.conversations.ManuallyAbandonedConversationCanceller

Public Member Functions

void setConversation (Conversation conversation)
 
boolean cancelBasedOnInput (ConversationContext context, String input)
 
ConversationCanceller clone ()
 

Detailed Description

A ConversationCanceller is a class that cancels an active Conversation. A Conversation can have more than one ConversationCanceller.

Definition at line 7 of file ConversationCanceller.java.

Member Function Documentation

boolean org.bukkit.conversations.ConversationCanceller.cancelBasedOnInput ( ConversationContext  context,
String  input 
)

Cancels a conversation based on user input.

Parameters
contextContext information about the conversation.
inputThe input text from the user.
Returns
True to cancel the conversation, False otherwise.

Implemented in org.bukkit.conversations.InactivityConversationCanceller, org.bukkit.conversations.ExactMatchConversationCanceller, and org.bukkit.conversations.ManuallyAbandonedConversationCanceller.

ConversationCanceller org.bukkit.conversations.ConversationCanceller.clone ( )

Allows the ConversationFactory to duplicate this ConversationCanceller when creating a new Conversation.

Implementing this method should reset any internal object state.

Returns
A clone.

Implemented in org.bukkit.conversations.InactivityConversationCanceller, org.bukkit.conversations.ExactMatchConversationCanceller, and org.bukkit.conversations.ManuallyAbandonedConversationCanceller.

void org.bukkit.conversations.ConversationCanceller.setConversation ( Conversation  conversation)

The documentation for this interface was generated from the following file: