Package | Description |
---|---|
org.bukkit.conversations |
Classes dedicated to facilitate direct player-to-plugin communication.
|
Modifier and Type | Class | Description |
---|---|---|
class |
BooleanPrompt |
BooleanPrompt is the base class for any prompt that requires a boolean
response from the user.
|
class |
FixedSetPrompt |
FixedSetPrompt is the base class for any prompt that requires a fixed set
response from the user.
|
class |
MessagePrompt |
MessagePrompt is the base class for any prompt that only displays a message
to the user and requires no input.
|
class |
NumericPrompt |
NumericPrompt is the base class for any prompt that requires a
Number response from the user. |
class |
PlayerNamePrompt |
PlayerNamePrompt is the base class for any prompt that requires the player
to enter another player's name.
|
class |
RegexPrompt |
RegexPrompt is the base class for any prompt that requires an input
validated by a regular expression.
|
class |
StringPrompt |
StringPrompt is the base class for any prompt that accepts an arbitrary
string from the user.
|
class |
ValidatingPrompt |
ValidatingPrompt is the base class for any prompt that requires validation.
|
Modifier and Type | Field | Description |
---|---|---|
protected Prompt |
Conversation.currentPrompt |
|
static Prompt |
Prompt.END_OF_CONVERSATION |
A convenience constant for indicating the end of a conversation.
|
protected Prompt |
ConversationFactory.firstPrompt |
Modifier and Type | Method | Description |
---|---|---|
Prompt |
MessagePrompt.acceptInput(ConversationContext context,
String input) |
Accepts and ignores any user input, returning the next prompt in the
prompt graph instead.
|
Prompt |
Prompt.acceptInput(ConversationContext context,
String input) |
Accepts and processes input from the user.
|
Prompt |
ValidatingPrompt.acceptInput(ConversationContext context,
String input) |
Accepts and processes input from the user and validates it.
|
protected abstract Prompt |
BooleanPrompt.acceptValidatedInput(ConversationContext context,
boolean input) |
Override this method to perform some action with the user's boolean
response.
|
protected Prompt |
BooleanPrompt.acceptValidatedInput(ConversationContext context,
String input) |
|
protected abstract Prompt |
NumericPrompt.acceptValidatedInput(ConversationContext context,
Number input) |
Override this method to perform some action with the user's integer
response.
|
protected Prompt |
NumericPrompt.acceptValidatedInput(ConversationContext context,
String input) |
|
protected Prompt |
PlayerNamePrompt.acceptValidatedInput(ConversationContext context,
String input) |
|
protected abstract Prompt |
PlayerNamePrompt.acceptValidatedInput(ConversationContext context,
Player input) |
Override this method to perform some action with the user's player name
response.
|
protected abstract Prompt |
ValidatingPrompt.acceptValidatedInput(ConversationContext context,
String input) |
Override this method to accept and processes the validated input from
the user.
|
protected abstract Prompt |
MessagePrompt.getNextPrompt(ConversationContext context) |
Override this method to return the next prompt in the prompt graph.
|
Modifier and Type | Method | Description |
---|---|---|
ConversationFactory |
ConversationFactory.withFirstPrompt(Prompt firstPrompt) |
Sets the first prompt to use in all generated conversations.
|
Constructor | Description |
---|---|
Conversation(Plugin plugin,
Conversable forWhom,
Prompt firstPrompt) |
Initializes a new Conversation.
|
Conversation(Plugin plugin,
Conversable forWhom,
Prompt firstPrompt,
Map<Object,Object> initialSessionData) |
Initializes a new Conversation.
|
Copyright © 2019. All rights reserved.