mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-12-29 13:27:37 +00:00
567 lines
49 KiB
HTML
567 lines
49 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (17) -->
|
||
|
|
<title>Conversation (Scissors-API 1.18.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, class: Conversation">
|
||
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||
|
|
<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="class-declaration-page">
|
||
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||
|
|
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><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="sub-nav">
|
||
|
|
<div>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Summary: </li>
|
||
|
|
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||
|
|
<li><a href="#field-summary">Field</a> | </li>
|
||
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method-summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li><a href="#field-detail">Field</a> | </li>
|
||
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
||
|
|
<li><a href="#method-detail">Method</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">
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.bukkit.conversations</a></div>
|
||
|
|
<h1 title="Class Conversation" class="title">Class Conversation</h1>
|
||
|
|
</div>
|
||
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||
|
|
<div class="inheritance">org.bukkit.conversations.Conversation</div>
|
||
|
|
</div>
|
||
|
|
<section class="class-description" id="class-description">
|
||
|
|
<hr>
|
||
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Conversation</span>
|
||
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||
|
|
<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. Conversation objects are not typically
|
||
|
|
instantiated directly. Instead a <a href="ConversationFactory.html" title="class in org.bukkit.conversations"><code>ConversationFactory</code></a> is used to
|
||
|
|
construct identical conversations on demand.
|
||
|
|
<p>
|
||
|
|
Conversation flow consists of a directed graph of <a href="Prompt.html" title="interface in org.bukkit.conversations"><code>Prompt</code></a> objects.
|
||
|
|
Each time a prompt gets input from the user, it must return the next prompt
|
||
|
|
in the graph. Since each Prompt chooses the next Prompt, complex
|
||
|
|
conversation trees can be implemented where the nature of the player's
|
||
|
|
response directs the flow of the conversation.
|
||
|
|
<p>
|
||
|
|
Each conversation has a <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations"><code>ConversationPrefix</code></a> that prepends all output
|
||
|
|
from the conversation to the player. The ConversationPrefix can be used to
|
||
|
|
display the plugin name or conversation status as the conversation evolves.
|
||
|
|
<p>
|
||
|
|
Each conversation has a timeout measured in the number of inactive seconds
|
||
|
|
to wait before abandoning the conversation. If the inactivity timeout is
|
||
|
|
reached, the conversation is abandoned and the user's incoming and outgoing
|
||
|
|
chat is returned to normal.
|
||
|
|
<p>
|
||
|
|
You should not construct a conversation manually. Instead, use the <a href="ConversationFactory.html" title="class in org.bukkit.conversations"><code>ConversationFactory</code></a> for access to all available options.</div>
|
||
|
|
</section>
|
||
|
|
<section class="summary">
|
||
|
|
<ul class="summary-list">
|
||
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
||
|
|
<h2>Nested Class Summary</h2>
|
||
|
|
<div class="caption"><span>Nested Classes</span></div>
|
||
|
|
<div class="summary-table three-column-summary">
|
||
|
|
<div class="table-header col-first">Modifier and Type</div>
|
||
|
|
<div class="table-header col-second">Class</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color"><code>static enum </code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="Conversation.ConversationState.html" class="type-name-link" title="enum class in org.bukkit.conversations">Conversation.ConversationState</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="field-summary" id="field-summary">
|
||
|
|
<h2>Field Summary</h2>
|
||
|
|
<div class="caption"><span>Fields</span></div>
|
||
|
|
<div class="summary-table three-column-summary">
|
||
|
|
<div class="table-header col-first">Modifier and Type</div>
|
||
|
|
<div class="table-header col-second">Field</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a>></code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="#abandonedListeners" class="member-name-link">abandonedListeners</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationCanceller.html" title="interface in org.bukkit.conversations">ConversationCanceller</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="#cancellers" class="member-name-link">cancellers</a></code></div>
|
||
|
|
<div class="col-last odd-row-color"> </div>
|
||
|
|
<div class="col-first even-row-color"><code>protected <a href="ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="#context" class="member-name-link">context</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
<div class="col-first odd-row-color"><code>protected <a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a></code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="#currentPrompt" class="member-name-link">currentPrompt</a></code></div>
|
||
|
|
<div class="col-last odd-row-color"> </div>
|
||
|
|
<div class="col-first even-row-color"><code>protected boolean</code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="#localEchoEnabled" class="member-name-link">localEchoEnabled</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="#modal" class="member-name-link">modal</a></code></div>
|
||
|
|
<div class="col-last odd-row-color"> </div>
|
||
|
|
<div class="col-first even-row-color"><code>protected <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations">ConversationPrefix</a></code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="#prefix" class="member-name-link">prefix</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="constructor-summary" id="constructor-summary">
|
||
|
|
<h2>Constructor Summary</h2>
|
||
|
|
<div class="caption"><span>Constructors</span></div>
|
||
|
|
<div class="summary-table two-column-summary">
|
||
|
|
<div class="table-header col-first">Constructor</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.plugin.Plugin,org.bukkit.conversations.Conversable,org.bukkit.conversations.Prompt)" class="member-name-link">Conversation</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../plugin/Plugin.html" title="interface in org.bukkit.plugin">Plugin</a> plugin,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a> forWhom,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a> firstPrompt)</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Initializes a new Conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.plugin.Plugin,org.bukkit.conversations.Conversable,org.bukkit.conversations.Prompt,java.util.Map)" class="member-name-link">Conversation</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../plugin/Plugin.html" title="interface in org.bukkit.plugin">Plugin</a> plugin,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a> forWhom,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a> firstPrompt,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> initialSessionData)</code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Initializes a new Conversation.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="method-summary" id="method-summary">
|
||
|
|
<h2>Method Summary</h2>
|
||
|
|
<div id="method-summary-table">
|
||
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||
|
|
<div class="table-header col-first">Modifier and Type</div>
|
||
|
|
<div class="table-header col-second">Method</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abandon()" class="member-name-link">abandon</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Abandons and resets the current conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abandon(org.bukkit.conversations.ConversationAbandonedEvent)" class="member-name-link">abandon</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedEvent.html" title="class in org.bukkit.conversations">ConversationAbandonedEvent</a> details)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Abandons and resets the current conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#acceptInput(java.lang.String)" class="member-name-link">acceptInput</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> input)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Passes player input into the current prompt.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addConversationAbandonedListener(org.bukkit.conversations.ConversationAbandonedListener)" class="member-name-link">addConversationAbandonedListener</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a> listener)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Adds a <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations"><code>ConversationAbandonedListener</code></a>.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#begin()" class="member-name-link">begin</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Displays the first prompt of this conversation and begins redirecting
|
||
|
|
the user's chat responses.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationCanceller.html" title="interface in org.bukkit.conversations">ConversationCanceller</a>></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCancellers()" class="member-name-link">getCancellers</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the list of <a href="ConversationCanceller.html" title="interface in org.bukkit.conversations"><code>ConversationCanceller</code></a>s</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Returns the Conversation's <a href="ConversationContext.html" title="class in org.bukkit.conversations"><code>ConversationContext</code></a>.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForWhom()" class="member-name-link">getForWhom</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the entity for whom this conversation is mediating.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations">ConversationPrefix</a></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrefix()" class="member-name-link">getPrefix</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations"><code>ConversationPrefix</code></a> that prepends all output from this
|
||
|
|
conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversation.ConversationState.html" title="enum class in org.bukkit.conversations">Conversation.ConversationState</a></code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Returns Returns the current state of the conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isLocalEchoEnabled()" class="member-name-link">isLocalEchoEnabled</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the status of local echo for this conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isModal()" class="member-name-link">isModal</a>()</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Gets the modality of this conversation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#outputNextPrompt()" class="member-name-link">outputNextPrompt</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Displays the next user prompt and abandons the conversation if the next
|
||
|
|
prompt is null.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeConversationAbandonedListener(org.bukkit.conversations.ConversationAbandonedListener)" class="member-name-link">removeConversationAbandonedListener</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a> listener)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Removes a <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations"><code>ConversationAbandonedListener</code></a>.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLocalEchoEnabled(boolean)" class="member-name-link">setLocalEchoEnabled</a><wbr>(boolean localEchoEnabled)</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the status of local echo for this conversation.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="details">
|
||
|
|
<ul class="details-list">
|
||
|
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="field-details" id="field-detail">
|
||
|
|
<h2>Field Details</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="currentPrompt">
|
||
|
|
<h3>currentPrompt</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a></span> <span class="element-name">currentPrompt</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="context">
|
||
|
|
<h3>context</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></span> <span class="element-name">context</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="modal">
|
||
|
|
<h3>modal</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">modal</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="localEchoEnabled">
|
||
|
|
<h3>localEchoEnabled</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">localEchoEnabled</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="prefix">
|
||
|
|
<h3>prefix</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ConversationPrefix.html" title="interface in org.bukkit.conversations">ConversationPrefix</a></span> <span class="element-name">prefix</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="cancellers">
|
||
|
|
<h3>cancellers</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationCanceller.html" title="interface in org.bukkit.conversations">ConversationCanceller</a>></span> <span class="element-name">cancellers</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="abandonedListeners">
|
||
|
|
<h3>abandonedListeners</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a>></span> <span class="element-name">abandonedListeners</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="constructor-details" id="constructor-detail">
|
||
|
|
<h2>Constructor Details</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>(org.bukkit.plugin.Plugin,org.bukkit.conversations.Conversable,org.bukkit.conversations.Prompt)">
|
||
|
|
<h3>Conversation</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Conversation</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../plugin/Plugin.html" title="interface in org.bukkit.plugin">Plugin</a> plugin,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a> forWhom,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a> firstPrompt)</span></div>
|
||
|
|
<div class="block">Initializes a new Conversation.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>plugin</code> - The plugin that owns this conversation.</dd>
|
||
|
|
<dd><code>forWhom</code> - The entity for whom this conversation is mediating.</dd>
|
||
|
|
<dd><code>firstPrompt</code> - The first prompt in the conversation graph.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>(org.bukkit.plugin.Plugin,org.bukkit.conversations.Conversable,org.bukkit.conversations.Prompt,java.util.Map)">
|
||
|
|
<h3>Conversation</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Conversation</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../plugin/Plugin.html" title="interface in org.bukkit.plugin">Plugin</a> plugin,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a> forWhom,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="Prompt.html" title="interface in org.bukkit.conversations">Prompt</a> firstPrompt,
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> initialSessionData)</span></div>
|
||
|
|
<div class="block">Initializes a new Conversation.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>plugin</code> - The plugin that owns this conversation.</dd>
|
||
|
|
<dd><code>forWhom</code> - The entity for whom this conversation is mediating.</dd>
|
||
|
|
<dd><code>firstPrompt</code> - The first prompt in the conversation graph.</dd>
|
||
|
|
<dd><code>initialSessionData</code> - Any initial values to put in the conversation
|
||
|
|
context sessionData map.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<li>
|
||
|
|
<section class="method-details" id="method-detail">
|
||
|
|
<h2>Method Details</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getForWhom()">
|
||
|
|
<h3>getForWhom</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversable.html" title="interface in org.bukkit.conversations">Conversable</a></span> <span class="element-name">getForWhom</span>()</div>
|
||
|
|
<div class="block">Gets the entity for whom this conversation is mediating.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The entity.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="isModal()">
|
||
|
|
<h3>isModal</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isModal</span>()</div>
|
||
|
|
<div class="block">Gets the modality of this conversation. If a conversation is modal, all
|
||
|
|
messages directed to the player are suppressed for the duration of the
|
||
|
|
conversation.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The conversation modality.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="isLocalEchoEnabled()">
|
||
|
|
<h3>isLocalEchoEnabled</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isLocalEchoEnabled</span>()</div>
|
||
|
|
<div class="block">Gets the status of local echo for this conversation. If local echo is
|
||
|
|
enabled, any text submitted to a conversation gets echoed back into the
|
||
|
|
submitter's chat window.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The status of local echo.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setLocalEchoEnabled(boolean)">
|
||
|
|
<h3>setLocalEchoEnabled</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLocalEchoEnabled</span><wbr><span class="parameters">(boolean localEchoEnabled)</span></div>
|
||
|
|
<div class="block">Sets the status of local echo for this conversation. If local echo is
|
||
|
|
enabled, any text submitted to a conversation gets echoed back into the
|
||
|
|
submitter's chat window.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>localEchoEnabled</code> - The status of local echo.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getPrefix()">
|
||
|
|
<h3>getPrefix</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations">ConversationPrefix</a></span> <span class="element-name">getPrefix</span>()</div>
|
||
|
|
<div class="block">Gets the <a href="ConversationPrefix.html" title="interface in org.bukkit.conversations"><code>ConversationPrefix</code></a> that prepends all output from this
|
||
|
|
conversation.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The ConversationPrefix in use.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getCancellers()">
|
||
|
|
<h3>getCancellers</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConversationCanceller.html" title="interface in org.bukkit.conversations">ConversationCanceller</a>></span> <span class="element-name">getCancellers</span>()</div>
|
||
|
|
<div class="block">Gets the list of <a href="ConversationCanceller.html" title="interface in org.bukkit.conversations"><code>ConversationCanceller</code></a>s</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The list.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getContext()">
|
||
|
|
<h3>getContext</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></span> <span class="element-name">getContext</span>()</div>
|
||
|
|
<div class="block">Returns the Conversation's <a href="ConversationContext.html" title="class in org.bukkit.conversations"><code>ConversationContext</code></a>.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The ConversationContext.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="begin()">
|
||
|
|
<h3>begin</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">begin</span>()</div>
|
||
|
|
<div class="block">Displays the first prompt of this conversation and begins redirecting
|
||
|
|
the user's chat responses.</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getState()">
|
||
|
|
<h3>getState</h3>
|
||
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="Conversation.ConversationState.html" title="enum class in org.bukkit.conversations">Conversation.ConversationState</a></span> <span class="element-name">getState</span>()</div>
|
||
|
|
<div class="block">Returns Returns the current state of the conversation.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>The current state of the conversation.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="acceptInput(java.lang.String)">
|
||
|
|
<h3>acceptInput</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">acceptInput</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> input)</span></div>
|
||
|
|
<div class="block">Passes player input into the current prompt. The next prompt (as
|
||
|
|
determined by the current prompt) is then displayed to the user.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>input</code> - The user's chat text.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="addConversationAbandonedListener(org.bukkit.conversations.ConversationAbandonedListener)">
|
||
|
|
<h3>addConversationAbandonedListener</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addConversationAbandonedListener</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a> listener)</span></div>
|
||
|
|
<div class="block">Adds a <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations"><code>ConversationAbandonedListener</code></a>.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>listener</code> - The listener to add.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="removeConversationAbandonedListener(org.bukkit.conversations.ConversationAbandonedListener)">
|
||
|
|
<h3>removeConversationAbandonedListener</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeConversationAbandonedListener</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations">ConversationAbandonedListener</a> listener)</span></div>
|
||
|
|
<div class="block">Removes a <a href="ConversationAbandonedListener.html" title="interface in org.bukkit.conversations"><code>ConversationAbandonedListener</code></a>.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>listener</code> - The listener to remove.</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="abandon()">
|
||
|
|
<h3>abandon</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">abandon</span>()</div>
|
||
|
|
<div class="block">Abandons and resets the current conversation. Restores the user's
|
||
|
|
normal chat behavior.</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="abandon(org.bukkit.conversations.ConversationAbandonedEvent)">
|
||
|
|
<h3>abandon</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">abandon</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="ConversationAbandonedEvent.html" title="class in org.bukkit.conversations">ConversationAbandonedEvent</a> details)</span></div>
|
||
|
|
<div class="block">Abandons and resets the current conversation. Restores the user's
|
||
|
|
normal chat behavior.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>details</code> - Details about why the conversation was abandoned</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="outputNextPrompt()">
|
||
|
|
<h3>outputNextPrompt</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">outputNextPrompt</span>()</div>
|
||
|
|
<div class="block">Displays the next user prompt and abandons the conversation if the next
|
||
|
|
prompt is null.</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
</main>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|