<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (16) --> <title>ServerSensor (Plan 5.4-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="declaration: package: com.djrapitops.plan.gathering, interface: ServerSensor"> <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"> <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> <script type="text/javascript" src="../../../../script-dir/jquery-3.5.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 evenRowColor = "even-row-color"; var oddRowColor = "odd-row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; var pathtoroot = "../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar.top"> <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li 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">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <div class="nav-list-search"><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 ========= --> <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">com.djrapitops.plan.gathering</a></div> <h1 title="Interface ServerSensor" class="title">Interface ServerSensor<W></h1> </div> <section class="description"> <dl class="notes"> <dt>Type Parameters:</dt> <dd><code>W</code> - Type of the class representing a minecraft world.</dd> </dl> <dl class="notes"> <dt>All Known Implementing Classes:</dt> <dd><code><a href="BukkitSensor.html" title="class in com.djrapitops.plan.gathering">BukkitSensor</a></code>, <code><a href="BungeeSensor.html" title="class in com.djrapitops.plan.gathering">BungeeSensor</a></code>, <code><a href="../../../../net/playeranalytics/plan/gathering/FabricSensor.html" title="class in net.playeranalytics.plan.gathering">FabricSensor</a></code>, <code><a href="NukkitSensor.html" title="class in com.djrapitops.plan.gathering">NukkitSensor</a></code>, <code><a href="SpongeSensor.html" title="class in com.djrapitops.plan.gathering">SpongeSensor</a></code>, <code><a href="VelocitySensor.html" title="class in com.djrapitops.plan.gathering">VelocitySensor</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ServerSensor<W></span></div> <div class="block">Allows sensing values from different server platforms.</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <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-tab2 method-summary-table-tab5 method-summary-table"><code>default int</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getChunkCount(W)">getChunkCount</a></span>​(<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a> world)</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default int</code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getEntityCount(W)">getEntityCount</a></span>​(<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a> world)</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>int</code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getOnlinePlayerCount()">getOnlinePlayerCount</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default double</code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getTPS()">getTPS</a></span>()</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"> </div> <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code>default <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a>></code></div> <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"><code><span class="member-name-link"><a href="#getWorlds()">getWorlds</a></span>()</code></div> <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab5 method-summary-table"> <div class="block">Get the worlds running on the server platform.</div> </div> <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>boolean</code></div> <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#supportsDirectTPS()">supportsDirectTPS</a></span>()</code></div> <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> <div class="block">Check if server platform provides TPS calculation.</div> </div> </div> </div> </div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method.detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="supportsDirectTPS()"> <h3>supportsDirectTPS</h3> <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">supportsDirectTPS</span>()</div> <div class="block">Check if server platform provides TPS calculation.</div> <dl class="notes"> <dt>Returns:</dt> <dd>false if the server doesn't count TPS.</dd> </dl> </section> </li> <li> <section class="detail" id="getOnlinePlayerCount()"> <h3>getOnlinePlayerCount</h3> <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getOnlinePlayerCount</span>()</div> </section> </li> <li> <section class="detail" id="getTPS()"> <h3>getTPS</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getTPS</span>()</div> </section> </li> <li> <section class="detail" id="getWorlds()"> <h3>getWorlds</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a>></span> <span class="element-name">getWorlds</span>()</div> <div class="block">Get the worlds running on the server platform.</div> <dl class="notes"> <dt>Returns:</dt> <dd>Empty collection if the platform doesn't support worlds.</dd> </dl> </section> </li> <li> <section class="detail" id="getChunkCount(W)"> <h3 id="getChunkCount(java.lang.Object)">getChunkCount</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getChunkCount</span>​<span class="parameters">(<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a> world)</span></div> </section> </li> <li> <section class="detail" id="getEntityCount(W)"> <h3 id="getEntityCount(java.lang.Object)">getEntityCount</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getEntityCount</span>​<span class="parameters">(<a href="ServerSensor.html" title="type parameter in ServerSensor">W</a> world)</span></div> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>