Prompt (Spigot-API 1.13.1-R0.1-SNAPSHOT API)

All Superinterfaces:

Cloneable

All Known Implementing Classes:

BooleanPrompt, FixedSetPrompt, MessagePrompt, NumericPrompt, PlayerNamePrompt, RegexPrompt, StringPrompt, ValidatingPrompt
```
public interface Prompt
extends Cloneable
```
A Prompt is the main constituent of a Conversation. Each prompt displays text to the user and optionally waits for a user's response. Prompts are chained together into a directed graph that represents the conversation flow. To halt a conversation, END_OF_CONVERSATION is returned in liu of another Prompt object.

Field Summary

Fields
Modifier and Type Field Description

static Prompt END_OF_CONVERSATION
A convenience constant for indicating the end of a conversation.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Prompt`	`acceptInput(ConversationContext context, String input)`	Accepts and processes input from the user.
`boolean`	`blocksForInput(ConversationContext context)`	Checks to see if this prompt implementation should wait for user input or immediately display the next prompt.
`String`	`getPromptText(ConversationContext context)`	Gets the text to display to the user when this prompt is first presented.

- Field Detail
  - END_OF_CONVERSATION
```
static final Prompt END_OF_CONVERSATION
```
    A convenience constant for indicating the end of a conversation.
- Method Detail
  - getPromptText
```
String getPromptText(ConversationContext context)
```
    Gets the text to display to the user when this prompt is first presented.
    
    Parameters:
    
    context - Context information about the conversation.
    
    Returns:
    
    The text to display.
  - blocksForInput
```
boolean blocksForInput(ConversationContext context)
```
    Checks to see if this prompt implementation should wait for user input or immediately display the next prompt.
    
    Parameters:
    
    context - Context information about the conversation.
    
    Returns:
    
    If true, the Conversation will wait for input before continuing.
  - acceptInput
```
Prompt acceptInput(ConversationContext context,
                   String input)
```
    Accepts and processes input from the user. Using the input, the next Prompt in the prompt graph is returned.
    
    Parameters:
    
    context - Context information about the conversation.
    
    input - The input text from the user.
    
    Returns:
    
    The next Prompt in the prompt graph.