Plan/all/com/djrapitops/plan/gathering/timed/TPSCalculator.html

366 lines
11 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>TPSCalculator (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2019-08-05 11:13:19 +02: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">
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TPSCalculator (Plan 5.2-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":10};
2019-08-05 11:13:19 +02:00
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 = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
2020-01-24 11:56:15 +01:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<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>
2020-01-24 11:56:15 +01:00
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<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">
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.gathering.timed</a></div>
2020-01-24 11:56:15 +01:00
<h2 title="Class TPSCalculator" class="title">Class TPSCalculator</h2>
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2020-01-24 11:56:15 +01:00
<li>com.djrapitops.plan.gathering.timed.TPSCalculator</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
2020-01-24 11:56:15 +01:00
<pre>public class <span class="typeNameLabel">TPSCalculator</span>
extends java.lang.Object</pre>
<div class="block">Utility for calculating TPS using nano time.
<p>
Math:
- Minecraft runs 20 ticks / second, 1 tick = 50ms
- To return 20 ticks, 1 second is expected
- If the call time is less than 1 second, the TPS is still 20, excess is not counted.
- If the call time is more than 1 second, the TPS is below 20
- If 2 seconds, TPS is 10
- If 4 seconds, TPS is 5
- If 20 seconds, TPS is 1
- If more than 20 seconds, TPS is 0 for 20 seconds and then according to the other rules.</div>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2020-01-24 11:56:15 +01:00
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="field.summary">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
2020-01-24 11:56:15 +01:00
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
2020-01-24 11:56:15 +01:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SECOND_NS">SECOND_NS</a></span></code></th>
<td class="colLast">&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">TPSCalculator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i0" class="altColor">
2020-01-24 11:56:15 +01:00
<td class="colFirst"><code>java.util.Optional&lt;java.lang.Double&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pulse(long)">pulse</a></span>&#8203;(long&nbsp;time)</code></th>
<td class="colLast">
2020-01-24 11:56:15 +01:00
<div class="block">Pulse the TPS clock.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2020-01-24 11:56:15 +01:00
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
2020-01-24 11:56:15 +01:00
<ul class="blockList">
<li class="blockList"><a id="field.detail">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="SECOND_NS">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SECOND_NS</h4>
<pre>public static final&nbsp;long SECOND_NS</pre>
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-01-24 11:56:15 +01:00
<h4>TPSCalculator</h4>
<pre>public&nbsp;TPSCalculator()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="pulse(long)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-01-24 11:56:15 +01:00
<h4>pulse</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;java.lang.Double&gt;&nbsp;pulse&#8203;(long&nbsp;time)</pre>
2020-01-24 11:56:15 +01:00
<div class="block">Pulse the TPS clock.</div>
2019-08-05 11:13:19 +02:00
<dl>
2020-01-24 11:56:15 +01:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>time</code> - Current epoch ms</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Average TPS for the minute, or empty.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
</div>
</main>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02: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>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
2020-01-24 11:56:15 +01:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<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>
2020-01-24 11:56:15 +01:00
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<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">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2019-08-05 11:13:19 +02:00
</body>
</html>