Plan/all/com/djrapitops/plan/gathering/BukkitSensor.html

431 lines
15 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2020-01-24 11:56:15 +01:00
<!-- NewPage -->
<html lang="en">
2020-01-24 11:56:15 +01:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>BukkitSensor (Plan 5.4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2020-01-24 11:56:15 +01:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
2020-01-24 11:56:15 +01:00
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
2020-01-24 11:56:15 +01:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BukkitSensor (Plan 5.4-SNAPSHOT API)";
2020-01-24 11:56:15 +01:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2020-01-24 11:56:15 +01:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2020-01-24 11:56:15 +01:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2020-01-24 11:56:15 +01:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2020-01-24 11:56:15 +01:00
<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">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2020-01-24 11:56:15 +01:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-01-24 11:56:15 +01:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2020-01-24 11:56:15 +01:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2020-01-24 11:56:15 +01:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2020-01-24 11:56:15 +01:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.gathering</a></div>
2020-01-24 11:56:15 +01:00
<h2 title="Class BukkitSensor" class="title">Class BukkitSensor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.gathering.BukkitSensor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
<hr>
<pre>@Singleton
public class <span class="typeNameLabel">BukkitSensor</span>
extends java.lang.Object
implements <a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</pre>
2020-01-24 11:56:15 +01:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2020-01-24 11:56:15 +01:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2020-01-24 11:56:15 +01:00
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.bukkit.Server)">BukkitSensor</a></span>&#8203;(org.bukkit.Server&nbsp;server)</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
</table>
</li>
</ul>
</section>
2020-01-24 11:56:15 +01:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
2020-01-24 11:56:15 +01:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChunkCount(org.bukkit.World)">getChunkCount</a></span>&#8203;(org.bukkit.World&nbsp;world)</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntityCount(org.bukkit.World)">getEntityCount</a></span>&#8203;(org.bukkit.World&nbsp;world)</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOnlinePlayerCount()">getOnlinePlayerCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTPS()">getTPS</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;org.bukkit.World&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorlds()">getWorlds</a></span>()</code></th>
<td class="colLast">
2020-01-24 11:56:15 +01:00
<div class="block">Get the worlds running on the server platform.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPaperAvailable()">isPaperAvailable</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
2020-01-24 11:56:15 +01:00
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportsDirectTPS()">supportsDirectTPS</a></span>()</code></th>
<td class="colLast">
2020-01-24 11:56:15 +01:00
<div class="block">Check if server platform provides TPS calculation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2020-01-24 11:56:15 +01:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.bukkit.Server)">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BukkitSensor</h4>
<pre>@Inject
public&nbsp;BukkitSensor&#8203;(org.bukkit.Server&nbsp;server)</pre>
2020-01-24 11:56:15 +01:00
</li>
</ul>
</li>
</ul>
</section>
2020-01-24 11:56:15 +01:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isPaperAvailable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPaperAvailable</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isPaperAvailable()</pre>
</li>
</ul>
<a id="supportsDirectTPS()">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsDirectTPS</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;supportsDirectTPS()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ServerSensor.html#supportsDirectTPS()">ServerSensor</a></code></span></div>
2020-01-24 11:56:15 +01:00
<div class="block">Check if server platform provides TPS calculation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#supportsDirectTPS()">supportsDirectTPS</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if the server doesn't count TPS.</dd>
</dl>
</li>
</ul>
<a id="getTPS()">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTPS</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getTPS()</pre>
2020-01-24 11:56:15 +01:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#getTPS()">getTPS</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
</li>
</ul>
<a id="getChunkCount(org.bukkit.World)">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChunkCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getChunkCount&#8203;(org.bukkit.World&nbsp;world)</pre>
2020-01-24 11:56:15 +01:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#getChunkCount(W)">getChunkCount</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
</li>
</ul>
<a id="getEntityCount(org.bukkit.World)">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getEntityCount&#8203;(org.bukkit.World&nbsp;world)</pre>
2020-01-24 11:56:15 +01:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#getEntityCount(W)">getEntityCount</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
</li>
</ul>
<a id="getOnlinePlayerCount()">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnlinePlayerCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOnlinePlayerCount()</pre>
2020-01-24 11:56:15 +01:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#getOnlinePlayerCount()">getOnlinePlayerCount</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
</li>
</ul>
<a id="getWorlds()">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWorlds</h4>
<pre class="methodSignature">public&nbsp;java.lang.Iterable&lt;org.bukkit.World&gt;&nbsp;getWorlds()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="ServerSensor.html#getWorlds()">ServerSensor</a></code></span></div>
2020-01-24 11:56:15 +01:00
<div class="block">Get the worlds running on the server platform.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ServerSensor.html#getWorlds()">getWorlds</a></code>&nbsp;in interface&nbsp;<code><a href="ServerSensor.html" title="interface in com.djrapitops.plan.gathering">ServerSensor</a>&lt;org.bukkit.World&gt;</code></dd>
2020-01-24 11:56:15 +01:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Empty collection if the platform doesn't support worlds.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2020-01-24 11:56:15 +01:00
</li>
</ul>
</div>
</div>
</main>
2020-01-24 11:56:15 +01:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2020-01-24 11:56:15 +01:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
2020-01-24 11:56:15 +01:00
<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">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
2020-01-24 11:56:15 +01:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-01-24 11:56:15 +01:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2020-01-24 11:56:15 +01:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2020-01-24 11:56:15 +01:00
</body>
</html>