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

311 lines
12 KiB
HTML
Raw Normal View History

2020-01-24 11:56:15 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>ServerSensor (Plan 5.1-SNAPSHOT API)</title>
2020-01-24 11:56:15 +01:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-03-21 15:43:05 +01:00
parent.document.title="ServerSensor (Plan 5.1-SNAPSHOT API)";
2020-01-24 11:56:15 +01:00
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":6,"i3":18,"i4":18,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../com/djrapitops/plan/gathering/NukkitSensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/gathering/ServerShutdownSave.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/gathering/ServerSensor.html" target="_top">Frames</a></li>
<li><a href="ServerSensor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.gathering</div>
<h2 title="Interface ServerSensor" class="title">Interface ServerSensor&lt;W&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>W</code> - Type of the class representing a minecraft world.</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/djrapitops/plan/gathering/BukkitSensor.html" title="class in com.djrapitops.plan.gathering">BukkitSensor</a>, <a href="../../../../com/djrapitops/plan/gathering/BungeeSensor.html" title="class in com.djrapitops.plan.gathering">BungeeSensor</a>, <a href="../../../../com/djrapitops/plan/gathering/NukkitSensor.html" title="class in com.djrapitops.plan.gathering">NukkitSensor</a>, <a href="../../../../com/djrapitops/plan/gathering/SpongeSensor.html" title="class in com.djrapitops.plan.gathering">SpongeSensor</a>, <a href="../../../../com/djrapitops/plan/gathering/VelocitySensor.html" title="class in com.djrapitops.plan.gathering">VelocitySensor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ServerSensor&lt;W&gt;</span></pre>
<div class="block">Allows sensing values from different server platforms.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#getChunkCount-W-">getChunkCount</a></span>(<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&nbsp;world)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#getEntityCount-W-">getEntityCount</a></span>(<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&nbsp;world)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#getOnlinePlayerCount--">getOnlinePlayerCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#getTPS--">getTPS</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default java.lang.Iterable&lt;<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#getWorlds--">getWorlds</a></span>()</code>
<div class="block">Get the worlds running on the server platform.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html#supportsDirectTPS--">supportsDirectTPS</a></span>()</code>
<div class="block">Check if server platform provides TPS calculation.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="supportsDirectTPS--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsDirectTPS</h4>
<pre>boolean&nbsp;supportsDirectTPS()</pre>
<div class="block">Check if server platform provides TPS calculation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if the server doesn't count TPS.</dd>
</dl>
</li>
</ul>
<a name="getOnlinePlayerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnlinePlayerCount</h4>
<pre>int&nbsp;getOnlinePlayerCount()</pre>
</li>
</ul>
<a name="getTPS--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTPS</h4>
<pre>default&nbsp;double&nbsp;getTPS()</pre>
</li>
</ul>
<a name="getWorlds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorlds</h4>
<pre>default&nbsp;java.lang.Iterable&lt;<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&gt;&nbsp;getWorlds()</pre>
<div class="block">Get the worlds running on the server platform.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Empty collection if the platform doesn't support worlds.</dd>
</dl>
</li>
</ul>
<a name="getChunkCount-java.lang.Object-">
<!-- -->
</a><a name="getChunkCount-W-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChunkCount</h4>
<pre>default&nbsp;int&nbsp;getChunkCount(<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&nbsp;world)</pre>
</li>
</ul>
<a name="getEntityCount-java.lang.Object-">
<!-- -->
</a><a name="getEntityCount-W-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEntityCount</h4>
<pre>default&nbsp;int&nbsp;getEntityCount(<a href="../../../../com/djrapitops/plan/gathering/ServerSensor.html" title="type parameter in ServerSensor">W</a>&nbsp;world)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../com/djrapitops/plan/gathering/NukkitSensor.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/gathering/ServerShutdownSave.html" title="class in com.djrapitops.plan.gathering"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/gathering/ServerSensor.html" target="_top">Frames</a></li>
<li><a href="ServerSensor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>