2022-08-23 01:41:55 +00:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
<!-- Generated by javadoc (17) -->
< title > org.bukkit.conversations (Scissors-API 1.19.2-R0.1-SNAPSHOT API)< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta name = "description" content = "declaration: package: org.bukkit.conversations" >
< meta name = "generator" content = "javadoc/PackageWriterImpl" >
< link rel = "stylesheet" type = "text/css" href = "../../../stylesheet.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../script-dir/jquery-ui.min.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../jquery-ui.overrides.css" title = "Style" >
< script type = "text/javascript" src = "../../../script.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jquery-3.5.1.min.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jquery-ui.min.js" > < / script >
< / head >
< body class = "package-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
< nav role = "navigation" >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "top-nav" id = "navbar-top" >
< div class = "skip-nav" > < a href = "#skip-navbar-top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< ul id = "navbar-top-firstrow" class = "nav-list" title = "Navigation" >
< li > < a href = "../../../index.html" > Overview< / a > < / li >
< li class = "nav-bar-cell1-rev" > Package< / li >
< li > Class< / li >
< li > < a href = "package-use.html" > Use< / a > < / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../help-doc.html#package" > Help< / a > < / li >
< / ul >
< / div >
< div class = "sub-nav" >
< div >
< ul class = "sub-nav-list" >
< li > Package: < / li >
< li > < a href = "#package-description" > Description< / a > | < / li >
< li > < a href = "#related-package-summary" > Related Packages< / a > | < / li >
< li > < a href = "#class-summary" > Classes and Interfaces< / a > < / li >
< / ul >
< / div >
< div class = "nav-list-search" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
< / div >
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
< / header >
< div class = "flex-content" >
< main role = "main" >
< div class = "header" >
< h1 title = "Package org.bukkit.conversations" class = "title" > Package org.bukkit.conversations< / h1 >
< / div >
< hr >
< div class = "package-signature" > package < span class = "element-name" > org.bukkit.conversations< / span > < / div >
< section class = "package-description" id = "package-description" >
< div class = "block" > Classes dedicated to facilitate direct player-to-plugin communication.< / div >
< / section >
< section class = "summary" >
< ul class = "summary-list" >
< li >
< div id = "related-package-summary" >
< div class = "caption" > < span > Related Packages< / span > < / div >
< div class = "summary-table two-column-summary" >
< div class = "table-header col-first" > Package< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color" > < a href = "../package-summary.html" > org.bukkit< / a > < / div >
< div class = "col-last even-row-color" >
< div class = "block" > The root package of the Bukkit API, contains generalized API classes.< / div >
< / div >
< / div >
< / div >
< / li >
< li >
< div id = "class-summary" >
< div class = "table-tabs" role = "tablist" aria-orientation = "horizontal" > < button id = "class-summary-tab0" role = "tab" aria-selected = "true" aria-controls = "class-summary.tabpanel" tabindex = "0" onkeydown = "switchTab(event)" onclick = "show('class-summary', 'class-summary', 2)" class = "active-table-tab" > All Classes and Interfaces< / button > < button id = "class-summary-tab1" role = "tab" aria-selected = "false" aria-controls = "class-summary.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('class-summary', 'class-summary-tab1', 2)" class = "table-tab" > Interfaces< / button > < button id = "class-summary-tab2" role = "tab" aria-selected = "false" aria-controls = "class-summary.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('class-summary', 'class-summary-tab2', 2)" class = "table-tab" > Classes< / button > < button id = "class-summary-tab3" role = "tab" aria-selected = "false" aria-controls = "class-summary.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('class-summary', 'class-summary-tab3', 2)" class = "table-tab" > Enum Classes< / button > < / div >
< div id = "class-summary.tabpanel" role = "tabpanel" >
< div class = "summary-table two-column-summary" aria-labelledby = "class-summary-tab0" >
< div class = "table-header col-first" > Class< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "BooleanPrompt.html" title = "class in org.bukkit.conversations" > BooleanPrompt< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > BooleanPrompt is the base class for any prompt that requires a boolean
response from the user.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab1" > < a href = "Conversable.html" title = "interface in org.bukkit.conversations" > Conversable< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab1" >
< div class = "block" > The Conversable interface is used to indicate objects that can have
conversations.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "Conversation.html" title = "class in org.bukkit.conversations" > Conversation< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > The Conversation class is responsible for tracking the current state of a
conversation, displaying prompts to the user, and dispatching the user's
response to the appropriate place.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab3" > < a href = "Conversation.ConversationState.html" title = "enum class in org.bukkit.conversations" > Conversation.ConversationState< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab3" > < / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "ConversationAbandonedEvent.html" title = "class in org.bukkit.conversations" > ConversationAbandonedEvent< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > ConversationAbandonedEvent contains information about an abandoned
conversation.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab1" > < a href = "ConversationAbandonedListener.html" title = "interface in org.bukkit.conversations" > ConversationAbandonedListener< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab1" > < / div >
< div class = "col-first even-row-color class-summary class-summary-tab1" > < a href = "ConversationCanceller.html" title = "interface in org.bukkit.conversations" > ConversationCanceller< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab1" >
< div class = "block" > A ConversationCanceller is a class that cancels an active < a href = "Conversation.html" title = "class in org.bukkit.conversations" > < code > Conversation< / code > < / a > .< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "ConversationContext.html" title = "class in org.bukkit.conversations" > ConversationContext< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > A ConversationContext provides continuity between nodes in the prompt graph
by giving the developer access to the subject of the conversation and a
generic map for storing values that are shared between all < a href = "Prompt.html" title = "interface in org.bukkit.conversations" > < code > Prompt< / code > < / a >
invocations.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "ConversationFactory.html" title = "class in org.bukkit.conversations" > ConversationFactory< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > A ConversationFactory is responsible for creating a < a href = "Conversation.html" title = "class in org.bukkit.conversations" > < code > Conversation< / code > < / a >
from a predefined template.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab1" > < a href = "ConversationPrefix.html" title = "interface in org.bukkit.conversations" > ConversationPrefix< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab1" >
< div class = "block" > A ConversationPrefix implementation prepends all output from the
conversation to the player.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "ExactMatchConversationCanceller.html" title = "class in org.bukkit.conversations" > ExactMatchConversationCanceller< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > An ExactMatchConversationCanceller cancels a conversation if the user
enters an exact input string< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "FixedSetPrompt.html" title = "class in org.bukkit.conversations" > FixedSetPrompt< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > FixedSetPrompt is the base class for any prompt that requires a fixed set
response from the user.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "InactivityConversationCanceller.html" title = "class in org.bukkit.conversations" > InactivityConversationCanceller< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > An InactivityConversationCanceller will cancel a < a href = "Conversation.html" title = "class in org.bukkit.conversations" > < code > Conversation< / code > < / a > after
a period of inactivity by the user.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "ManuallyAbandonedConversationCanceller.html" title = "class in org.bukkit.conversations" > ManuallyAbandonedConversationCanceller< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > The ManuallyAbandonedConversationCanceller is only used as part of a < a href = "ConversationAbandonedEvent.html" title = "class in org.bukkit.conversations" > < code > ConversationAbandonedEvent< / code > < / a > to indicate that the conversation was manually
abandoned by programmatically calling the abandon() method on it.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "MessagePrompt.html" title = "class in org.bukkit.conversations" > MessagePrompt< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > MessagePrompt is the base class for any prompt that only displays a message
to the user and requires no input.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "NullConversationPrefix.html" title = "class in org.bukkit.conversations" > NullConversationPrefix< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > NullConversationPrefix is a < a href = "ConversationPrefix.html" title = "interface in org.bukkit.conversations" > < code > ConversationPrefix< / code > < / a > implementation that
displays nothing in front of conversation output.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "NumericPrompt.html" title = "class in org.bukkit.conversations" > NumericPrompt< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > NumericPrompt is the base class for any prompt that requires a < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title = "class or interface in java.lang" class = "external-link" > < code > Number< / code > < / a > response from the user.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "PlayerNamePrompt.html" title = "class in org.bukkit.conversations" > PlayerNamePrompt< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > PlayerNamePrompt is the base class for any prompt that requires the player
to enter another player's name.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "PluginNameConversationPrefix.html" title = "class in org.bukkit.conversations" > PluginNameConversationPrefix< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > PluginNameConversationPrefix is a < a href = "ConversationPrefix.html" title = "interface in org.bukkit.conversations" > < code > ConversationPrefix< / code > < / a > implementation
that displays the plugin name in front of conversation output.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab1" > < a href = "Prompt.html" title = "interface in org.bukkit.conversations" > Prompt< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab1" >
< div class = "block" > A Prompt is the main constituent of a < a href = "Conversation.html" title = "class in org.bukkit.conversations" > < code > Conversation< / code > < / a > .< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "RegexPrompt.html" title = "class in org.bukkit.conversations" > RegexPrompt< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > RegexPrompt is the base class for any prompt that requires an input
validated by a regular expression.< / div >
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "StringPrompt.html" title = "class in org.bukkit.conversations" > StringPrompt< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
< div class = "block" > StringPrompt is the base class for any prompt that accepts an arbitrary
string from the user.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "ValidatingPrompt.html" title = "class in org.bukkit.conversations" > ValidatingPrompt< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
< div class = "block" > ValidatingPrompt is the base class for any prompt that requires validation.< / div >
< / div >
< / div >
< / div >
< / div >
< / li >
< / ul >
< / section >
< / main >
< / div >
< / div >
< / body >
< / html >
