mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-08 18:00:01 +00:00
290 lines
47 KiB
HTML
290 lines
47 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Uses of Class org.bukkit.conversations.ConversationContext (Scissors-API 1.19.4-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="use: package: org.bukkit.conversations, class: ConversationContext">
|
|
<meta name="generator" content="javadoc/ClassUseWriter">
|
|
<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.6.0.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-use-page">
|
|
<script type="text/javascript">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><a href="../ConversationContext.html" title="class in org.bukkit.conversations">Class</a></li>
|
|
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<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="Uses of Class org.bukkit.conversations.ConversationContext" class="title">Uses of Class<br>org.bukkit.conversations.ConversationContext</h1>
|
|
</div>
|
|
<div class="caption"><span>Packages that use <a href="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></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="#org.bukkit.conversations">org.bukkit.conversations</a></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Classes dedicated to facilitate direct player-to-plugin communication.</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-uses">
|
|
<ul class="block-list">
|
|
<li>
|
|
<section class="detail" id="org.bukkit.conversations">
|
|
<h2>Uses of <a href="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> in <a href="../package-summary.html">org.bukkit.conversations</a></h2>
|
|
<div class="caption"><span>Fields in <a href="../package-summary.html">org.bukkit.conversations</a> declared as <a href="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">Conversation.</span><code><a href="../Conversation.html#context" class="member-name-link">context</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.conversations</a> that return <a href="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></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">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><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"><span class="type-name-label">Conversation.</span><code><a href="../Conversation.html#getContext()" class="member-name-link">getContext</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<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"><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 odd-row-color"><span class="type-name-label">ConversationAbandonedEvent.</span><code><a href="../ConversationAbandonedEvent.html#getContext()" class="member-name-link">getContext</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Gets the abandoned conversation's conversation context.</div>
|
|
</div>
|
|
</div>
|
|
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.conversations</a> with parameters of type <a href="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a></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">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code><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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">MessagePrompt.</span><code><a href="../MessagePrompt.html#acceptInput(org.bukkit.conversations.ConversationContext,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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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://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">
|
|
<div class="block">Accepts and ignores any user input, returning the next prompt in the
|
|
prompt graph instead.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">Prompt.</span><code><a href="../Prompt.html#acceptInput(org.bukkit.conversations.ConversationContext,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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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://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 odd-row-color">
|
|
<div class="block">Accepts and processes input from the user.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">ValidatingPrompt.</span><code><a href="../ValidatingPrompt.html#acceptInput(org.bukkit.conversations.ConversationContext,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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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://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">
|
|
<div class="block">Accepts and processes input from the user and validates it.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected abstract <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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">BooleanPrompt.</span><code><a href="../BooleanPrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,boolean)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
boolean input)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Override this method to perform some action with the user's boolean
|
|
response.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected <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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">BooleanPrompt.</span><code><a href="../BooleanPrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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"> </div>
|
|
<div class="col-first odd-row-color"><code>protected abstract <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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,java.lang.Number)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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/Number.html" title="class or interface in java.lang" class="external-link">Number</a> input)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Override this method to perform some action with the user's integer
|
|
response.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected <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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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"> </div>
|
|
<div class="col-first odd-row-color"><code>protected <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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">PlayerNamePrompt.</span><code><a href="../PlayerNamePrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected abstract <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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">PlayerNamePrompt.</span><code><a href="../PlayerNamePrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,org.bukkit.entity.Player)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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="../../entity/Player.html" title="interface in org.bukkit.entity">Player</a> input)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Override this method to perform some action with the user's player name
|
|
response.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected abstract <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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">ValidatingPrompt.</span><code><a href="../ValidatingPrompt.html#acceptValidatedInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">acceptValidatedInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color">
|
|
<div class="block">Override this method to accept and processes the validated input from
|
|
the user.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">MessagePrompt.</span><code><a href="../MessagePrompt.html#blocksForInput(org.bukkit.conversations.ConversationContext)" class="member-name-link">blocksForInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Message prompts never wait for user input before continuing.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">Prompt.</span><code><a href="../Prompt.html#blocksForInput(org.bukkit.conversations.ConversationContext)" class="member-name-link">blocksForInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Checks to see if this prompt implementation should wait for user input
|
|
or immediately display the next prompt.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">StringPrompt.</span><code><a href="../StringPrompt.html#blocksForInput(org.bukkit.conversations.ConversationContext)" class="member-name-link">blocksForInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Ensures that the prompt waits for the user to provide input.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">ValidatingPrompt.</span><code><a href="../ValidatingPrompt.html#blocksForInput(org.bukkit.conversations.ConversationContext)" class="member-name-link">blocksForInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Ensures that the prompt waits for the user to provide input.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">ConversationCanceller.</span><code><a href="../ConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">cancelBasedOnInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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">
|
|
<div class="block">Cancels a conversation based on user input.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">ExactMatchConversationCanceller.</span><code><a href="../ExactMatchConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">cancelBasedOnInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">InactivityConversationCanceller.</span><code><a href="../InactivityConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">cancelBasedOnInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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"> </div>
|
|
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">ManuallyAbandonedConversationCanceller.</span><code><a href="../ManuallyAbandonedConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">cancelBasedOnInput</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected <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://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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#getFailedValidationText(org.bukkit.conversations.ConversationContext,java.lang.Number)" class="member-name-link">getFailedValidationText</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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/Number.html" title="class or interface in java.lang" class="external-link">Number</a> invalidInput)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Optionally override this method to display an additional message if the
|
|
user enters an invalid numeric input.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected <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://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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#getFailedValidationText(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">getFailedValidationText</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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> invalidInput)</code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected <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://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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">ValidatingPrompt.</span><code><a href="../ValidatingPrompt.html#getFailedValidationText(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">getFailedValidationText</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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> invalidInput)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Optionally override this method to display an additional message if the
|
|
user enters an invalid input.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected <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://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></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#getInputNotNumericText(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">getInputNotNumericText</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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> invalidInput)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Optionally override this method to display an additional message if the
|
|
user enters an invalid number.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected abstract <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></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">MessagePrompt.</span><code><a href="../MessagePrompt.html#getNextPrompt(org.bukkit.conversations.ConversationContext)" class="member-name-link">getNextPrompt</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Override this method to return the next prompt in the prompt graph.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">ConversationPrefix.</span><code><a href="../ConversationPrefix.html#getPrefix(org.bukkit.conversations.ConversationContext)" class="member-name-link">getPrefix</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Gets the prefix to use before each message to the player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">NullConversationPrefix.</span><code><a href="../NullConversationPrefix.html#getPrefix(org.bukkit.conversations.ConversationContext)" class="member-name-link">getPrefix</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Prepends each conversation message with an empty string.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">PluginNameConversationPrefix.</span><code><a href="../PluginNameConversationPrefix.html#getPrefix(org.bukkit.conversations.ConversationContext)" class="member-name-link">getPrefix</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Prepends each conversation message with the plugin name.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">Prompt.</span><code><a href="../Prompt.html#getPromptText(org.bukkit.conversations.ConversationContext)" class="member-name-link">getPromptText</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Gets the text to display to the user when this prompt is first
|
|
presented.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">BooleanPrompt.</span><code><a href="../BooleanPrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">FixedSetPrompt.</span><code><a href="../FixedSetPrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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"> </div>
|
|
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">PlayerNamePrompt.</span><code><a href="../PlayerNamePrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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"> </div>
|
|
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">RegexPrompt.</span><code><a href="../RegexPrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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 odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected abstract boolean</code></div>
|
|
<div class="col-second even-row-color"><span class="type-name-label">ValidatingPrompt.</span><code><a href="../ValidatingPrompt.html#isInputValid(org.bukkit.conversations.ConversationContext,java.lang.String)" class="member-name-link">isInputValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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">
|
|
<div class="block">Override this method to check the validity of the player's input.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color"><span class="type-name-label">NumericPrompt.</span><code><a href="../NumericPrompt.html#isNumberValid(org.bukkit.conversations.ConversationContext,java.lang.Number)" class="member-name-link">isNumberValid</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="../ConversationContext.html" title="class in org.bukkit.conversations">ConversationContext</a> context,
|
|
<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/Number.html" title="class or interface in java.lang" class="external-link">Number</a> input)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Override this method to do further validation on the numeric player
|
|
input after the input has been determined to actually be a number.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|