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 |
---|---|---|
@Nullable Prompt |
MessagePrompt.acceptInput(@NotNull ConversationContext context,
@Nullable String input) |
Accepts and ignores any user input, returning the next prompt in the
prompt graph instead.
|
@Nullable Prompt |
Prompt.acceptInput(@NotNull ConversationContext context,
@Nullable String input) |
Accepts and processes input from the user.
|
@Nullable Prompt |
ValidatingPrompt.acceptInput(@NotNull ConversationContext context,
@Nullable String input) |
Accepts and processes input from the user and validates it.
|
protected abstract @Nullable Prompt |
BooleanPrompt.acceptValidatedInput(@NotNull ConversationContext context,
boolean input) |
Override this method to perform some action with the user's boolean
response.
|
protected @Nullable Prompt |
BooleanPrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull String input) |
|
protected abstract @Nullable Prompt |
NumericPrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull Number input) |
Override this method to perform some action with the user's integer
response.
|
protected @Nullable Prompt |
NumericPrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull String input) |
|
protected @Nullable Prompt |
PlayerNamePrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull String input) |
|
protected abstract @Nullable Prompt |
PlayerNamePrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull Player input) |
Override this method to perform some action with the user's player name
response.
|
protected abstract @Nullable Prompt |
ValidatingPrompt.acceptValidatedInput(@NotNull ConversationContext context,
@NotNull String input) |
Override this method to accept and processes the validated input from
the user.
|
protected abstract @Nullable Prompt |
MessagePrompt.getNextPrompt(@NotNull ConversationContext context) |
Override this method to return the next prompt in the prompt graph.
|
Modifier and Type | Method | Description |
---|---|---|
@NotNull ConversationFactory |
ConversationFactory.withFirstPrompt(@Nullable Prompt firstPrompt) |
Sets the first prompt to use in all generated conversations.
|
Constructor | Description |
---|---|
Conversation(@Nullable Plugin plugin,
@NotNull Conversable forWhom,
@Nullable Prompt firstPrompt) |
Initializes a new Conversation.
|
Conversation(@Nullable Plugin plugin,
@NotNull Conversable forWhom,
@Nullable Prompt firstPrompt,
@NotNull Map<Object,Object> initialSessionData) |
Initializes a new Conversation.
|
Copyright © 2020. All rights reserved.