Index (dialog 1.1.2 API)

A B C D E F G H I K L M O P R S T U V W
All Classes and Interfaces|All Packages

A

activePromptsCount() - Method in interface com.cotani.dialog.api.DialogService: Returns the count of currently active awaiting prompts.
anvil() - Method in interface com.cotani.dialog.api.DialogService: Creates a new anvil prompt builder.
anvil() - Static method in class com.cotani.dialog.CotaniDialogs: Creates a new anvil prompt builder.
AnvilPrompt - Interface in com.cotani.dialog.api: Interactive Anvil GUI prompt capturing text typed by the player in the rename field.
AnvilPromptBuilder - Class in com.cotani.dialog.api: Fluent builder for creating AnvilPrompt instances.
AnvilPromptBuilder() - Constructor for class com.cotani.dialog.api.AnvilPromptBuilder
attempt() - Method in record class com.cotani.dialog.api.PromptContext: Returns the value of the attempt record component.

B

build(DialogService) - Method in class com.cotani.dialog.api.AnvilPromptBuilder
build(DialogService) - Method in class com.cotani.dialog.api.ChatPromptBuilder
build(DialogService) - Method in class com.cotani.dialog.api.ConversationWizardBuilder
builder() - Static method in interface com.cotani.dialog.api.AnvilPrompt: Creates a new builder for configuring an Anvil prompt.
builder() - Static method in interface com.cotani.dialog.api.ChatPrompt: Creates a new builder for configuring a typed chat prompt.
builder() - Static method in interface com.cotani.dialog.api.ConversationWizard: Creates a new conversation wizard builder.

C

cancelKeywords() - Method in interface com.cotani.dialog.api.ChatPrompt: Keywords that immediately trigger user cancellation when typed by the player.
cancelKeywords(String...) - Method in class com.cotani.dialog.api.ChatPromptBuilder
cancelKeywords(Set) - Method in class com.cotani.dialog.api.ChatPromptBuilder
cancelled(CancelReason) - Static method in interface com.cotani.dialog.api.PromptResult: Creates a cancelled prompt result with the given reason.
Cancelled(CancelReason) - Constructor for record class com.cotani.dialog.api.PromptResult.Cancelled: Creates an instance of a Cancelled record class.
cancelPrompt(UUID, CancelReason) - Method in interface com.cotani.dialog.api.DialogService: Cancels any active prompt for the given player.
CancelReason - Enum Class in com.cotani.dialog.api: Reasons why an active dialog or input prompt was cancelled.
cause() - Method in record class com.cotani.dialog.api.PromptResult.Failure: Returns the value of the cause record component.
chat() - Method in interface com.cotani.dialog.api.DialogService: Creates a new chat prompt builder.
chat() - Static method in class com.cotani.dialog.CotaniDialogs: Creates a new chat prompt builder.
ChatPrompt<T> - Interface in com.cotani.dialog.api: Interactive chat-based prompt capturing and validating player text input asynchronously.
ChatPromptBuilder<T> - Class in com.cotani.dialog.api: Fluent builder for creating ChatPrompt instances.
ChatPromptBuilder() - Constructor for class com.cotani.dialog.api.ChatPromptBuilder
close() - Method in interface com.cotani.dialog.api.DialogService
com.cotani.dialog - package com.cotani.dialog
com.cotani.dialog.api - package com.cotani.dialog.api
ConversationWizard - Interface in com.cotani.dialog.api: Multi-step conversational wizard orchestrating sequential input prompts for a player.
ConversationWizardBuilder - Class in com.cotani.dialog.api: Fluent builder for creating ConversationWizard instances.
ConversationWizardBuilder() - Constructor for class com.cotani.dialog.api.ConversationWizardBuilder
ConversationWizardBuilder.WizardContext - Record Class in com.cotani.dialog.api
ConversationWizardBuilder.WizardStepDefinition - Record Class in com.cotani.dialog.api
CotaniDialogs - Class in com.cotani.dialog: Entrypoint factory for the cotani-dialog module.
create(Plugin) - Static method in class com.cotani.dialog.CotaniDialogs: Creates and registers a new DialogService for the given plugin.
create(Plugin, PaperTaskScheduler) - Static method in class com.cotani.dialog.CotaniDialogs: Creates and registers a new DialogService using the given scheduler.
createAnvilPrompt(Component, String, Duration, ItemStack) - Method in interface com.cotani.dialog.api.DialogService: Internal factory for instantiating an AnvilPrompt.
createChatPrompt(Component, Duration, Set, int, Function, BiFunction, BiConsumer) - Method in interface com.cotani.dialog.api.DialogService: Internal factory for instantiating a typed ChatPrompt.
createWizard(List) - Method in interface com.cotani.dialog.api.DialogService: Internal factory for instantiating a ConversationWizard.

D

DialogService - Interface in com.cotani.dialog.api: Service managing non-blocking interactive player prompts (Chat, Anvil) and multi-step dialog wizards.

E

elapsed() - Method in record class com.cotani.dialog.api.PromptContext: Calculates the duration elapsed since this prompt was opened.
equals(Object) - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.dialog.api.PromptContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.dialog.api.PromptResult.Cancelled: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.dialog.api.PromptResult.Failure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.cotani.dialog.api.PromptResult.Success: Indicates whether some other object is "equal to" this one.
error(Throwable) - Static method in interface com.cotani.dialog.api.PromptResult: Creates an error prompt result with the given throwable cause.

F

failure(Throwable) - Static method in interface com.cotani.dialog.api.PromptResult: Creates a failure prompt result with the given throwable cause.
Failure(Throwable) - Constructor for record class com.cotani.dialog.api.PromptResult.Failure: Creates an instance of a Failure record class.
filter(Predicate, Component) - Method in class com.cotani.dialog.api.ChatPromptBuilder

G

get(String) - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext
get(String, Class) - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext

H

hasActivePrompt(UUID) - Method in interface com.cotani.dialog.api.DialogService: Checks if the player currently has an active awaiting prompt.
hashCode() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.dialog.api.PromptContext: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.dialog.api.PromptResult.Cancelled: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.dialog.api.PromptResult.Failure: Returns a hash code value for this object.
hashCode() - Method in record class com.cotani.dialog.api.PromptResult.Success: Returns a hash code value for this object.

I

ifCancelled(Consumer) - Method in interface com.cotani.dialog.api.PromptResult: Executes the given consumer if this prompt was cancelled.
ifSuccess(Consumer) - Method in interface com.cotani.dialog.api.PromptResult: Executes the given consumer if this result is a success.
initialText() - Method in interface com.cotani.dialog.api.AnvilPrompt: Initial text prepopulated in the Anvil rename input.
initialText(String) - Method in class com.cotani.dialog.api.AnvilPromptBuilder
isCancelled() - Method in interface com.cotani.dialog.api.PromptResult: Checks if the prompt was cancelled due to timeout, disconnect, or user action.
isError() - Method in interface com.cotani.dialog.api.PromptResult: Checks if the prompt ended due to an unexpected error or exception.
isFailure() - Method in interface com.cotani.dialog.api.PromptResult: Checks if the prompt ended due to an unexpected error or exception.
isSuccess() - Method in interface com.cotani.dialog.api.PromptResult: Checks if the prompt completed with a successfully parsed value.

K

key() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Returns the value of the key record component.

L

leftItem(ItemStack) - Method in class com.cotani.dialog.api.AnvilPromptBuilder

M

map(Function) - Method in interface com.cotani.dialog.api.PromptResult: Maps the parsed value to another type if successful.
MAX_ATTEMPTS_EXCEEDED - Enum constant in enum class com.cotani.dialog.api.CancelReason: The player exceeded the maximum number of failed input attempts.
maxAttempts() - Method in interface com.cotani.dialog.api.ChatPrompt: Maximum invalid attempts allowed before the prompt fails.
maxAttempts(int) - Method in class com.cotani.dialog.api.ChatPromptBuilder
message() - Method in interface com.cotani.dialog.api.ChatPrompt: The prompt instruction message displayed to the player.
message(String) - Method in class com.cotani.dialog.api.ChatPromptBuilder
message(Component) - Method in class com.cotani.dialog.api.ChatPromptBuilder

O

of(Component) - Static method in interface com.cotani.dialog.api.ChatPrompt: Creates a simple String-based chat prompt with the given message.
onCancel(BiConsumer) - Method in class com.cotani.dialog.api.ChatPromptBuilder
onInvalidInput(BiFunction) - Method in class com.cotani.dialog.api.ChatPromptBuilder
onInvalidInput(Component) - Method in class com.cotani.dialog.api.ChatPromptBuilder
open(Player) - Method in interface com.cotani.dialog.api.AnvilPrompt: Opens the Anvil prompt for the target player.
OVERRIDDEN - Enum constant in enum class com.cotani.dialog.api.CancelReason: A new prompt was opened for the same player, overriding the previous active prompt.

P

parser(Function) - Method in class com.cotani.dialog.api.ChatPromptBuilder
player() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Returns the value of the player record component.
player() - Method in record class com.cotani.dialog.api.PromptContext: Returns the value of the player record component.
PLAYER_QUIT - Enum constant in enum class com.cotani.dialog.api.CancelReason: The target player disconnected from the server while the prompt was active.
PLUGIN_DISABLE - Enum constant in enum class com.cotani.dialog.api.CancelReason: The owning plugin or server was disabled while the prompt was active.
previousAnswers() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Returns the value of the previousAnswers record component.
promptAnvil(Player, Component, String) - Method in interface com.cotani.dialog.api.DialogService: Prompts the player via Anvil GUI with the given title and default text.
promptChat(Player, String) - Method in interface com.cotani.dialog.api.DialogService: Prompts the player in chat with the given MiniMessage text, returning their raw typed response.
promptChat(Player, Component) - Method in interface com.cotani.dialog.api.DialogService: Prompts the player in chat with the given message, returning their raw typed response.
PromptContext - Record Class in com.cotani.dialog.api: Contextual state provided during prompt evaluation and validation.
PromptContext(Player, int, Instant) - Constructor for record class com.cotani.dialog.api.PromptContext: Creates an instance of a PromptContext record class.
PromptResult<T> - Interface in com.cotani.dialog.api: Result outcome of a player input prompt or conversational dialog.
PromptResult.Cancelled<T> - Record Class in com.cotani.dialog.api: Cancelled prompt outcome.
PromptResult.Failure<T> - Record Class in com.cotani.dialog.api: Failed prompt outcome.
PromptResult.Success<T> - Record Class in com.cotani.dialog.api: Successful prompt outcome.
promptSupplier() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Returns the value of the promptSupplier record component.

R

reason() - Method in record class com.cotani.dialog.api.PromptResult.Cancelled: Returns the value of the reason record component.

S

start(Player) - Method in interface com.cotani.dialog.api.ChatPrompt: Starts the chat prompt for the target player.
start(Player) - Method in interface com.cotani.dialog.api.ConversationWizard: Starts the multi-step conversation wizard for the player.
startedAt() - Method in record class com.cotani.dialog.api.PromptContext: Returns the value of the startedAt record component.
step(String, ChatPromptBuilder) - Method in class com.cotani.dialog.api.ConversationWizardBuilder
step(String, Function) - Method in class com.cotani.dialog.api.ConversationWizardBuilder
success(T) - Static method in interface com.cotani.dialog.api.PromptResult: Creates a successful prompt result with the given parsed value.
Success(T) - Constructor for record class com.cotani.dialog.api.PromptResult.Success: Creates an instance of a Success record class.

T

timeout() - Method in interface com.cotani.dialog.api.AnvilPrompt: Timeout after which the Anvil prompt is automatically cancelled and closed.
timeout() - Method in interface com.cotani.dialog.api.ChatPrompt: Timeout after which the prompt is cancelled if no valid response is received.
timeout(Duration) - Method in class com.cotani.dialog.api.AnvilPromptBuilder
timeout(Duration) - Method in class com.cotani.dialog.api.ChatPromptBuilder
TIMEOUT - Enum constant in enum class com.cotani.dialog.api.CancelReason: The prompt exceeded its configured timeout duration without receiving valid input.
title() - Method in interface com.cotani.dialog.api.AnvilPrompt: Title of the Anvil inventory window.
title(String) - Method in class com.cotani.dialog.api.AnvilPromptBuilder
title(Component) - Method in class com.cotani.dialog.api.AnvilPromptBuilder
toString() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Returns a string representation of this record class.
toString() - Method in record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Returns a string representation of this record class.
toString() - Method in record class com.cotani.dialog.api.PromptContext: Returns a string representation of this record class.
toString() - Method in record class com.cotani.dialog.api.PromptResult.Cancelled: Returns a string representation of this record class.
toString() - Method in record class com.cotani.dialog.api.PromptResult.Failure: Returns a string representation of this record class.
toString() - Method in record class com.cotani.dialog.api.PromptResult.Success: Returns a string representation of this record class.

U

USER_CANCELLED - Enum constant in enum class com.cotani.dialog.api.CancelReason: The player explicitly typed a cancellation keyword (e.g.

V

value() - Method in record class com.cotani.dialog.api.PromptResult.Success: Returns the value of the value record component.
valueOf(String) - Static method in enum class com.cotani.dialog.api.CancelReason: Returns the enum constant of this class with the specified name.
valueOptional() - Method in interface com.cotani.dialog.api.PromptResult: Returns the parsed value as an Optional.
valueOrElse(T) - Method in interface com.cotani.dialog.api.PromptResult: Returns the value if successful, or the given fallback otherwise.
valueOrThrow() - Method in interface com.cotani.dialog.api.PromptResult: Returns the value if successful, or throws NoSuchElementException if cancelled or errored.
values() - Static method in enum class com.cotani.dialog.api.CancelReason: Returns an array containing the constants of this enum class, in the order they are declared.

W

wizard() - Method in interface com.cotani.dialog.api.DialogService: Creates a new conversation wizard builder.
wizard() - Static method in class com.cotani.dialog.CotaniDialogs: Creates a new conversation wizard builder.
WizardContext(Player, Map) - Constructor for record class com.cotani.dialog.api.ConversationWizardBuilder.WizardContext: Creates an instance of a WizardContext record class.
WizardStepDefinition(String, Function) - Constructor for record class com.cotani.dialog.api.ConversationWizardBuilder.WizardStepDefinition: Creates an instance of a WizardStepDefinition record class.

A B C D E F G H I K L M O P R S T U V W
All Classes and Interfaces|All Packages