mirror of
https://github.com/Minestom/Minestom.git
synced 2025-01-25 01:21:20 +01:00
505 lines
27 KiB
HTML
505 lines
27 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>Sidebar (Minestom 1.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: net.minestom.server.scoreboard, class: Sidebar">
|
|
<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.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flexBox">
|
|
<header role="banner" class="flexHeader">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">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">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<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="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="skipNav"><a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
</nav>
|
|
</header>
|
|
<div class="flexContent">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.minestom.server.scoreboard</a></div>
|
|
<h1 title="Class Sidebar" class="title">Class Sidebar</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">net.minestom.server.scoreboard.Sidebar</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="Scoreboard.html" title="interface in net.minestom.server.scoreboard">Scoreboard</a></code>, <code><a href="../Viewable.html" title="interface in net.minestom.server">Viewable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">Sidebar</span>
|
|
extends java.lang.Object
|
|
implements <a href="Scoreboard.html" title="interface in net.minestom.server.scoreboard">Scoreboard</a></pre>
|
|
<div class="block">Represents a sidebar which can contain up to 16 <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a>.
|
|
<p>
|
|
In order to use it you need to create a new instance using <a href="#%3Cinit%3E(java.lang.String)"><code>Sidebar(String)</code></a> and create new lines
|
|
with <a href="#createLine(net.minestom.server.scoreboard.Sidebar.ScoreboardLine)"><code>createLine(ScoreboardLine)</code></a>. You can then add a <a href="../entity/Player.html" title="class in net.minestom.server.entity"><code>Player</code></a> to the viewing list using <a href="#addViewer(net.minestom.server.entity.Player)"><code>addViewer(Player)</code></a>
|
|
and remove him later with <a href="#removeViewer(net.minestom.server.entity.Player)"><code>removeViewer(Player)</code></a>.
|
|
<p>
|
|
Lines can be modified using their respective identifier using
|
|
<a href="#updateLineContent(java.lang.String,net.minestom.server.chat.ColoredText)"><code>updateLineContent(String, ColoredText)</code></a> and <a href="#updateLineScore(java.lang.String,int)"><code>updateLineScore(String, int)</code></a>.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="nestedClassSummary"><a id="nested.class.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Class</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static class </code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard">Sidebar.ScoreboardLine</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This class is used to create a line for the sidebar.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorSummary"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">Sidebar</a></span>​(java.lang.String title)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new sidebar</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addViewer(net.minestom.server.entity.Player)">addViewer</a></span>​(<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Adds a viewer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createLine(net.minestom.server.scoreboard.Sidebar.ScoreboardLine)">createLine</a></span>​(<a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard">Sidebar.ScoreboardLine</a> scoreboardLine)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code><a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard">Sidebar.ScoreboardLine</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLine(java.lang.String)">getLine</a></span>​(java.lang.String id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectiveName()">getObjectiveName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the objective name of the scoreboard</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i4">
|
|
<td class="colFirst"><code>java.util.Set<<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getViewers()">getViewers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets all the viewers of this viewable element.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i5">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeLine(java.lang.String)">removeLine</a></span>​(java.lang.String id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i6">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeViewer(net.minestom.server.entity.Player)">removeViewer</a></span>​(<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes a viewer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i7">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTitle(java.lang.String)">setTitle</a></span>​(java.lang.String title)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Changes the <a href="Sidebar.html" title="class in net.minestom.server.scoreboard"><code>Sidebar</code></a> title</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i8">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateLineContent(java.lang.String,net.minestom.server.chat.ColoredText)">updateLineContent</a></span>​(java.lang.String id,
|
|
<a href="../chat/ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> content)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Updates a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> content through the given identifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i9">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateLineScore(java.lang.String,int)">updateLineScore</a></span>​(java.lang.String id,
|
|
int score)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Updates the score of a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from interface net.minestom.server.scoreboard.<a href="Scoreboard.html" title="interface in net.minestom.server.scoreboard">Scoreboard</a></h3>
|
|
<a id="methods.inherited.from.class.net.minestom.server.scoreboard.Scoreboard">
|
|
<!-- -->
|
|
</a><code><a href="Scoreboard.html#getCreationObjectivePacket(java.lang.String,net.minestom.server.network.packet.server.play.ScoreboardObjectivePacket.Type)">getCreationObjectivePacket</a>, <a href="Scoreboard.html#getDestructionObjectivePacket()">getDestructionObjectivePacket</a>, <a href="Scoreboard.html#getDisplayScoreboardPacket(byte)">getDisplayScoreboardPacket</a>, <a href="Scoreboard.html#updateScore(net.minestom.server.entity.Player,int)">updateScore</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from interface net.minestom.server.<a href="../Viewable.html" title="interface in net.minestom.server">Viewable</a></h3>
|
|
<a id="methods.inherited.from.class.net.minestom.server.Viewable">
|
|
<!-- -->
|
|
</a><code><a href="../Viewable.html#isViewer(net.minestom.server.entity.Player)">isViewer</a>, <a href="../Viewable.html#sendPacketsToViewers(net.minestom.server.network.packet.server.ServerPacket...)">sendPacketsToViewers</a>, <a href="../Viewable.html#sendPacketToViewers(net.minestom.server.network.packet.server.ServerPacket)">sendPacketToViewers</a>, <a href="../Viewable.html#sendPacketToViewersAndSelf(net.minestom.server.network.packet.server.ServerPacket)">sendPacketToViewersAndSelf</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorDetails"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>(java.lang.String)">Sidebar</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">Sidebar</span>​(<span class="arguments">java.lang.String title)</span></div>
|
|
<div class="block">Creates a new sidebar</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - The title of the sidebar</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="setTitle(java.lang.String)">setTitle</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setTitle</span>​(<span class="arguments">java.lang.String title)</span></div>
|
|
<div class="block">Changes the <a href="Sidebar.html" title="class in net.minestom.server.scoreboard"><code>Sidebar</code></a> title</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>title</code> - The new sidebar title</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="createLine(net.minestom.server.scoreboard.Sidebar.ScoreboardLine)">createLine</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">createLine</span>​(<span class="arguments"><a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard">Sidebar.ScoreboardLine</a> scoreboardLine)</span></div>
|
|
<div class="block">Creates a new <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>scoreboardLine</code> - the new scoreboard line</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - if the sidebar cannot take more line</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if the sidebar already contains the line <code>scoreboardLine</code>
|
|
or has a line with the same id</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="updateLineContent(java.lang.String,net.minestom.server.chat.ColoredText)">updateLineContent</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">updateLineContent</span>​(<span class="arguments">java.lang.String id,
|
|
<a href="../chat/ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> content)</span></div>
|
|
<div class="block">Updates a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> content through the given identifier.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The identifier of the <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a></dd>
|
|
<dd><code>content</code> - The new content for the <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="updateLineScore(java.lang.String,int)">updateLineScore</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">updateLineScore</span>​(<span class="arguments">java.lang.String id,
|
|
int score)</span></div>
|
|
<div class="block">Updates the score of a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The identifier of the team</dd>
|
|
<dd><code>score</code> - The new score for the <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getLine(java.lang.String)">getLine</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard">Sidebar.ScoreboardLine</a></span> <span class="memberName">getLine</span>​(<span class="arguments">java.lang.String id)</span></div>
|
|
<div class="block">Gets a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The identifier of the line</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> or <code>null</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="removeLine(java.lang.String)">removeLine</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">removeLine</span>​(<span class="arguments">java.lang.String id)</span></div>
|
|
<div class="block">Removes a <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a> through the given identifier</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - the identifier of the <a href="Sidebar.ScoreboardLine.html" title="class in net.minestom.server.scoreboard"><code>Sidebar.ScoreboardLine</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="addViewer(net.minestom.server.entity.Player)">addViewer</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">addViewer</span>​(<span class="arguments">@NotNull
|
|
<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Viewable.html#addViewer(net.minestom.server.entity.Player)">Viewable</a></code></span></div>
|
|
<div class="block">Adds a viewer.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Viewable.html#addViewer(net.minestom.server.entity.Player)">addViewer</a></code> in interface <code><a href="../Viewable.html" title="interface in net.minestom.server">Viewable</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>player</code> - the viewer to add</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the player has been added, false otherwise (could be because he is already a viewer)</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="removeViewer(net.minestom.server.entity.Player)">removeViewer</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">removeViewer</span>​(<span class="arguments">@NotNull
|
|
<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Viewable.html#removeViewer(net.minestom.server.entity.Player)">Viewable</a></code></span></div>
|
|
<div class="block">Removes a viewer.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Viewable.html#removeViewer(net.minestom.server.entity.Player)">removeViewer</a></code> in interface <code><a href="../Viewable.html" title="interface in net.minestom.server">Viewable</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>player</code> - the viewer to remove</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the player has been removed, false otherwise (could be because he was not a viewer)</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getViewers()">getViewers</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="returnType">java.util.Set<<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a>></span> <span class="memberName">getViewers</span>()</div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Viewable.html#getViewers()">Viewable</a></code></span></div>
|
|
<div class="block">Gets all the viewers of this viewable element.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Viewable.html#getViewers()">getViewers</a></code> in interface <code><a href="../Viewable.html" title="interface in net.minestom.server">Viewable</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A Set containing all the element's viewers</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getObjectiveName()">getObjectiveName</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.lang.String</span> <span class="memberName">getObjectiveName</span>()</div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Scoreboard.html#getObjectiveName()">Scoreboard</a></code></span></div>
|
|
<div class="block">Gets the objective name of the scoreboard</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Scoreboard.html#getObjectiveName()">getObjectiveName</a></code> in interface <code><a href="Scoreboard.html" title="interface in net.minestom.server.scoreboard">Scoreboard</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the objective name</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">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">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<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>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|