mirror of https://github.com/Minestom/Minestom.git
453 lines
37 KiB
HTML
453 lines
37 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) -->
|
|
<title>Audiences (minestom dev 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: net.minestom.server.adventure.audience, class: Audiences">
|
|
<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">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
|
<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>
|
|
<ul class="sub-nav-list-small">
|
|
<li>
|
|
<p>Summary:</p>
|
|
<ul>
|
|
<li>Nested</li>
|
|
<li>Field</li>
|
|
<li><a href="#constructor-summary">Constr</a></li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Detail:</p>
|
|
<ul>
|
|
<li>Field</li>
|
|
<li><a href="#constructor-detail">Constr</a></li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list">
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </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>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
|
|
<input type="text" id="search-input" disabled placeholder="Search">
|
|
<input type="reset" id="reset-button" disabled value="reset">
|
|
</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">net.minestom.server.adventure.audience</a></div>
|
|
<h1 title="Class Audiences" class="title">Class Audiences</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/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">net.minestom.server.adventure.audience.Audiences</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">Audiences</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/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">Utility class to access Adventure audiences.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== 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()" class="member-name-link">Audiences</a>()</code></div>
|
|
<div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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" aria-labelledby="method-summary-table-tab0">
|
|
<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 method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#all()" class="member-name-link">all</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all audience members.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#all(java.util.function.Predicate)" class="member-name-link">all</a><wbr>(@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all audience members that match the given predicate.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#console()" class="member-name-link">console</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the console as an audience.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#custom(net.kyori.adventure.key.Key)" class="member-name-link">custom</a><wbr>(@NotNull net.kyori.adventure.key.Key key)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members stored using the given key.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#custom(net.kyori.adventure.key.Keyed)" class="member-name-link">custom</a><wbr>(@NotNull net.kyori.adventure.key.Keyed keyed)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members stored using the given keyed object.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#custom(net.kyori.adventure.key.Keyed,java.util.function.Predicate)" class="member-name-link">custom</a><wbr>(@NotNull net.kyori.adventure.key.Keyed keyed,
|
|
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members stored using the given keyed object that match
|
|
the given predicate.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#custom(net.kyori.adventure.key.Key,java.util.function.Predicate)" class="member-name-link">custom</a><wbr>(@NotNull net.kyori.adventure.key.Key key,
|
|
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members stored using the given key that match the
|
|
given predicate.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#customs()" class="member-name-link">customs</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#customs(java.util.function.Predicate)" class="member-name-link">customs</a><wbr>(@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all custom audience members matching the given predicate.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience">AudienceProvider</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#iterable()" class="member-name-link">iterable</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience"><code>AudienceProvider</code></a> that provides iterables of audience members.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#players()" class="member-name-link">players</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all audience members that are of type <a href="../../entity/Player.html" title="class in net.minestom.server.entity"><code>Player</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#players(java.util.function.Predicate)" class="member-name-link">players</a><wbr>(@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="../../entity/Player.html" title="class in net.minestom.server.entity">Player</a>> filter)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets all audience members that are of type <a href="../../entity/Player.html" title="class in net.minestom.server.entity"><code>Player</code></a> and match the predicate.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="AudienceRegistry.html" title="class in net.minestom.server.adventure.audience">AudienceRegistry</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#registry()" class="member-name-link">registry</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the audience registry used to register custom audiences.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#server()" class="member-name-link">server</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the combination of <a href="#players()"><code>players()</code></a> and <a href="#console()"><code>console()</code></a>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @NotNull <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience">AudienceProvider</a><wbr><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#single()" class="member-name-link">single</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience"><code>AudienceProvider</code></a> that provides forwarding audiences.</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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>Audiences</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Audiences</span>()</div>
|
|
</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="single()">
|
|
<h3>single</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience">AudienceProvider</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>></span> <span class="element-name">single</span>()</div>
|
|
<div class="block">Gets the <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience"><code>AudienceProvider</code></a> that provides forwarding audiences.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the instance</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="iterable()">
|
|
<h3>iterable</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience">AudienceProvider</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>>></span> <span class="element-name">iterable</span>()</div>
|
|
<div class="block">Gets the <a href="AudienceProvider.html" title="interface in net.minestom.server.adventure.audience"><code>AudienceProvider</code></a> that provides iterables of audience members.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the instance</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="all()">
|
|
<h3>all</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">all</span>()</div>
|
|
<div class="block">Gets all audience members. This returns <a href="#players()"><code>players()</code></a> combined with
|
|
<a href="#customs()"><code>customs()</code></a> and <a href="#console()"><code>console()</code></a>. This can be a costly operation, so it
|
|
is often preferable to use <a href="#server()"><code>server()</code></a> instead.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>all audience members</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="players()">
|
|
<h3>players</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">players</span>()</div>
|
|
<div class="block">Gets all audience members that are of type <a href="../../entity/Player.html" title="class in net.minestom.server.entity"><code>Player</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>all players</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="players(java.util.function.Predicate)">
|
|
<h3>players</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">players</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="../../entity/Player.html" title="class in net.minestom.server.entity">Player</a>> filter)</span></div>
|
|
<div class="block">Gets all audience members that are of type <a href="../../entity/Player.html" title="class in net.minestom.server.entity"><code>Player</code></a> and match the predicate.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>filter</code> - the predicate</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all players matching the predicate</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="console()">
|
|
<h3>console</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">console</span>()</div>
|
|
<div class="block">Gets the console as an audience.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the console</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="server()">
|
|
<h3>server</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">server</span>()</div>
|
|
<div class="block">Gets the combination of <a href="#players()"><code>players()</code></a> and <a href="#console()"><code>console()</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the audience of all players and the console</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="customs()">
|
|
<h3>customs</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">customs</span>()</div>
|
|
<div class="block">Gets all custom audience members.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>all custom audience members</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="custom(net.kyori.adventure.key.Keyed)">
|
|
<h3>custom</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">custom</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull net.kyori.adventure.key.Keyed keyed)</span></div>
|
|
<div class="block">Gets all custom audience members stored using the given keyed object.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>keyed</code> - the keyed object</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all custom audience members stored using the key of the object</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="custom(net.kyori.adventure.key.Key)">
|
|
<h3>custom</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">custom</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull net.kyori.adventure.key.Key key)</span></div>
|
|
<div class="block">Gets all custom audience members stored using the given key.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - the key</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all custom audience members stored using the key</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="custom(net.kyori.adventure.key.Keyed,java.util.function.Predicate)">
|
|
<h3>custom</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">custom</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull net.kyori.adventure.key.Keyed keyed,
|
|
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</span></div>
|
|
<div class="block">Gets all custom audience members stored using the given keyed object that match
|
|
the given predicate.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>keyed</code> - the keyed object</dd>
|
|
<dd><code>filter</code> - the predicate</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all custom audience members stored using the key</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="custom(net.kyori.adventure.key.Key,java.util.function.Predicate)">
|
|
<h3>custom</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">custom</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull net.kyori.adventure.key.Key key,
|
|
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</span></div>
|
|
<div class="block">Gets all custom audience members stored using the given key that match the
|
|
given predicate.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>key</code> - the key</dd>
|
|
<dd><code>filter</code> - the predicate</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all custom audience members stored using the key</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="customs(java.util.function.Predicate)">
|
|
<h3>customs</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">customs</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</span></div>
|
|
<div class="block">Gets all custom audience members matching the given predicate.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>filter</code> - the predicate</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all matching custom audience members</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="all(java.util.function.Predicate)">
|
|
<h3>all</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a></span> <span class="element-name">all</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><<a href="https://jd.adventure.kyori.net/api/4.15.0/net/kyori/adventure/audience/Audience.html" title="class or interface in net.kyori.adventure.audience" class="external-link">Audience</a>> filter)</span></div>
|
|
<div class="block">Gets all audience members that match the given predicate.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>filter</code> - the predicate</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all matching audience members</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registry()">
|
|
<h3>registry</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public static</span> <span class="return-type">@NotNull <a href="AudienceRegistry.html" title="class in net.minestom.server.adventure.audience">AudienceRegistry</a></span> <span class="element-name">registry</span>()</div>
|
|
<div class="block">Gets the audience registry used to register custom audiences.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the registry</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|