mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2025-02-22 19:00:37 +00:00
201 lines
20 KiB
HTML
201 lines
20 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (17) -->
|
||
|
|
<title>Uses of Class org.bukkit.help.HelpTopic (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.help, class: HelpTopic">
|
||
|
|
<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="../HelpTopic.html" title="class in org.bukkit.help">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.help.HelpTopic" class="title">Uses of Class<br>org.bukkit.help.HelpTopic</h1>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Packages that use <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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.command.defaults">org.bukkit.command.defaults</a></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Commands for emulating the Minecraft commands and other necessary ones for
|
||
|
|
use by a Bukkit implementation.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color"><a href="#org.bukkit.help">org.bukkit.help</a></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Classes used to manipulate the default command and topic assistance system.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<section class="class-uses">
|
||
|
|
<ul class="block-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="org.bukkit.command.defaults">
|
||
|
|
<h2>Uses of <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> in <a href="../../command/defaults/package-summary.html">org.bukkit.command.defaults</a></h2>
|
||
|
|
<div class="caption"><span>Methods in <a href="../../command/defaults/package-summary.html">org.bukkit.command.defaults</a> that return <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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>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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a></code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">HelpCommand.</span><code><a href="../../command/defaults/HelpCommand.html#findPossibleMatches(java.lang.String)" class="member-name-link">findPossibleMatches</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> searchString)</code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="org.bukkit.help">
|
||
|
|
<h2>Uses of <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> in <a href="../package-summary.html">org.bukkit.help</a></h2>
|
||
|
|
<div class="caption"><span>Subclasses of <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> in <a href="../package-summary.html">org.bukkit.help</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">Class</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color"><code>class </code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="../GenericCommandHelpTopic.html" class="type-name-link" title="class in org.bukkit.help">GenericCommandHelpTopic</a></code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Lacking an alternative, the help system will create instances of
|
||
|
|
GenericCommandHelpTopic for each command in the server's CommandMap.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color"><code>class </code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="../IndexHelpTopic.html" class="type-name-link" title="class in org.bukkit.help">IndexHelpTopic</a></code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">This help topic generates a list of other help topics.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Fields in <a href="../package-summary.html">org.bukkit.help</a> with type parameters of type <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a>></code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">IndexHelpTopic.</span><code><a href="../IndexHelpTopic.html#allTopics" class="member-name-link">allTopics</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.help</a> that return <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a></code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">HelpTopicFactory.</span><code><a href="../HelpTopicFactory.html#createTopic(TCommand)" class="member-name-link">createTopic</a><wbr>(<a href="../HelpTopicFactory.html" title="type parameter in HelpTopicFactory">TCommand</a> command)</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">This method accepts a command deriving from a custom command base class
|
||
|
|
and constructs a custom HelpTopic for it.</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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a></code></div>
|
||
|
|
<div class="col-second odd-row-color"><span class="type-name-label">HelpMap.</span><code><a href="../HelpMap.html#getHelpTopic(java.lang.String)" class="member-name-link">getHelpTopic</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> topicName)</code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Returns a help topic for a given topic name.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.help</a> that return types with arguments of type <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a>></code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">HelpMap.</span><code><a href="../HelpMap.html#getHelpTopics()" class="member-name-link">getHelpTopics</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Returns a collection of all the registered help topics.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.help</a> with parameters of type <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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>void</code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">HelpMap.</span><code><a href="../HelpMap.html#addTopic(org.bukkit.help.HelpTopic)" class="member-name-link">addTopic</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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> topic)</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Adds a topic to the server's help index.</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/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">IndexHelpTopic.</span><code><a href="../IndexHelpTopic.html#buildIndexLine(org.bukkit.command.CommandSender,org.bukkit.help.HelpTopic)" class="member-name-link">buildIndexLine</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="../../command/CommandSender.html" title="interface in org.bukkit.command">CommandSender</a> sender,
|
||
|
|
<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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> topic)</code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Builds individual lines in the index topic.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first even-row-color"><code>int</code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">HelpTopicComparator.</span><code><a href="../HelpTopicComparator.html#compare(org.bukkit.help.HelpTopic,org.bukkit.help.HelpTopic)" class="member-name-link">compare</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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> lhs,
|
||
|
|
<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="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a> rhs)</code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Method parameters in <a href="../package-summary.html">org.bukkit.help</a> with type arguments of type <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</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>protected void</code></div>
|
||
|
|
<div class="col-second even-row-color"><span class="type-name-label">IndexHelpTopic.</span><code><a href="../IndexHelpTopic.html#setTopicsCollection(java.util.Collection)" class="member-name-link">setTopicsCollection</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/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a>> topics)</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Sets the contents of the internal allTopics collection.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="caption"><span>Constructor parameters in <a href="../package-summary.html">org.bukkit.help</a> with type arguments of type <a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a></span></div>
|
||
|
|
<div class="summary-table three-column-summary">
|
||
|
|
<div class="table-header col-first">Modifier</div>
|
||
|
|
<div class="table-header col-second">Constructor</div>
|
||
|
|
<div class="table-header col-last">Description</div>
|
||
|
|
<div class="col-first even-row-color"><code> </code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="../IndexHelpTopic.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.util.Collection)" class="member-name-link">IndexHelpTopic</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> name,
|
||
|
|
<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> shortText,
|
||
|
|
<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> permission,
|
||
|
|
<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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a>> topics)</code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
<div class="col-first odd-row-color"><code> </code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="../IndexHelpTopic.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.util.Collection,java.lang.String)" class="member-name-link">IndexHelpTopic</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> name,
|
||
|
|
<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> shortText,
|
||
|
|
<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> permission,
|
||
|
|
<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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../HelpTopic.html" title="class in org.bukkit.help">HelpTopic</a>> topics,
|
||
|
|
<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> preamble)</code></div>
|
||
|
|
<div class="col-last odd-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</main>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|