Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.conversations.MessagePrompt Class Referenceabstract

MessagePrompt is the base class for any prompt that only displays a message to the user and requires no input. More...

+ Inheritance diagram for org.bukkit.conversations.MessagePrompt:
+ Collaboration diagram for org.bukkit.conversations.MessagePrompt:

Public Member Functions

 MessagePrompt ()
 
boolean blocksForInput (ConversationContext context)
 Message prompts never wait for user input before continuing.
 
Prompt acceptInput (ConversationContext context, String input)
 Accepts and ignores any user input, returning the next prompt in the prompt graph instead.
 
- Public Member Functions inherited from org.bukkit.conversations.Prompt
String getPromptText (ConversationContext context)
 Gets the text to display to the user when this prompt is first presented.
 
boolean blocksForInput (ConversationContext context)
 Checks to see if this prompt implementation should wait for user input or immediately display the next prompt.
 
Prompt acceptInput (ConversationContext context, String input)
 Accepts and processes input from the user.
 

Protected Member Functions

abstract Prompt getNextPrompt (ConversationContext context)
 Override this method to return the next prompt in the prompt graph.
 

Additional Inherited Members

- Static Public Attributes inherited from org.bukkit.conversations.Prompt
static final Prompt END_OF_CONVERSATION = null
 A convenience constant for indicating the end of a conversation.
 

Detailed Description

MessagePrompt is the base class for any prompt that only displays a message to the user and requires no input.

Definition at line 6 of file MessagePrompt.java.

Constructor & Destructor Documentation

org.bukkit.conversations.MessagePrompt.MessagePrompt ( )

Definition at line 8 of file MessagePrompt.java.

Member Function Documentation

Prompt org.bukkit.conversations.MessagePrompt.acceptInput ( ConversationContext  context,
String  input 
)

Accepts and ignores any user input, returning the next prompt in the prompt graph instead.

Parameters
contextContext information about the conversation.
inputIgnored.
Returns
The next prompt in the prompt graph.

Definition at line 27 of file MessagePrompt.java.

References org.bukkit.conversations.MessagePrompt.getNextPrompt().

boolean org.bukkit.conversations.MessagePrompt.blocksForInput ( ConversationContext  context)

Message prompts never wait for user input before continuing.

Parameters
contextContext information about the conversation.
Returns
Always false.

Definition at line 17 of file MessagePrompt.java.

abstract Prompt org.bukkit.conversations.MessagePrompt.getNextPrompt ( ConversationContext  context)
protectedpure virtual

Override this method to return the next prompt in the prompt graph.

Parameters
contextContext information about the conversation.
Returns
The next prompt in the prompt graph.

Referenced by org.bukkit.conversations.MessagePrompt.acceptInput().


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