Plan/all/com/djrapitops/plan/gathering/domain/GMTimes.html

513 lines
18 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>GMTimes (Plan 5.4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<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>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GMTimes (Plan 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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">
<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>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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">
<!-- -->
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.gathering.domain</a></div>
<h2 title="Class GMTimes" class="title">Class GMTimes</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">com.djrapitops.plan.gathering.domain.TimeKeeper</a></li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.gathering.domain.GMTimes</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">GMTimes</span>
extends <a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">TimeKeeper</a></pre>
<div class="block">TimeKeeper class that tracks the time spent in each GameMode based on Playtime.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.djrapitops.plan.gathering.domain.TimeKeeper">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.djrapitops.plan.gathering.domain.<a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">TimeKeeper</a></h3>
<code><a href="TimeKeeper.html#lastStateChange">lastStateChange</a>, <a href="TimeKeeper.html#state">state</a>, <a href="TimeKeeper.html#times">times</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<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>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">GMTimes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">GMTimes</a></span>&#8203;(java.lang.String&nbsp;lastState)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,long)">GMTimes</a></span>&#8203;(java.lang.String&nbsp;lastState,
long&nbsp;lastStateChange)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map)">GMTimes</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;&nbsp;times)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,java.lang.String,long)">GMTimes</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;&nbsp;times,
java.lang.String&nbsp;lastState,
long&nbsp;lastStateChange)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</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>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGMKeyArray()">getGMKeyArray</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Optional&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMostUsedGameMode()">getMostUsedGameMode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#magicNumberToGMName(int)">magicNumberToGMName</a></span>&#8203;(int&nbsp;magicNumber)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetTimes(long)">resetTimes</a></span>&#8203;(long&nbsp;time)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllGMTimes(long...)">setAllGMTimes</a></span>&#8203;(long...&nbsp;times)</code></th>
<td class="colLast">
<div class="block">Sets times for all 4 gamemodes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toJson()">toJson</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.gathering.domain.TimeKeeper">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.djrapitops.plan.gathering.domain.<a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">TimeKeeper</a></h3>
<code><a href="TimeKeeper.html#addTime(java.lang.String,long)">addTime</a>, <a href="TimeKeeper.html#changeState(java.lang.String,long)">changeState</a>, <a href="TimeKeeper.html#equals(java.lang.Object)">equals</a>, <a href="TimeKeeper.html#getLastStateChange()">getLastStateChange</a>, <a href="TimeKeeper.html#getTime(java.lang.String)">getTime</a>, <a href="TimeKeeper.html#getTimes()">getTimes</a>, <a href="TimeKeeper.html#getTotal()">getTotal</a>, <a href="TimeKeeper.html#hashCode()">hashCode</a>, <a href="TimeKeeper.html#renameState(java.lang.String,java.lang.String)">renameState</a>, <a href="TimeKeeper.html#resetState(java.lang.String)">resetState</a>, <a href="TimeKeeper.html#resetState(java.lang.String,long)">resetState</a>, <a href="TimeKeeper.html#setLastStateChange(long)">setLastStateChange</a>, <a href="TimeKeeper.html#setState(java.lang.String)">setState</a>, <a href="TimeKeeper.html#setTime(java.lang.String,long)">setTime</a>, <a href="TimeKeeper.html#setTimes(java.util.Map)">setTimes</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.util.Map,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GMTimes</h4>
<pre>public&nbsp;GMTimes&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;&nbsp;times,
java.lang.String&nbsp;lastState,
long&nbsp;lastStateChange)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GMTimes</h4>
<pre>public&nbsp;GMTimes&#8203;(java.lang.String&nbsp;lastState,
long&nbsp;lastStateChange)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GMTimes</h4>
<pre>public&nbsp;GMTimes&#8203;(java.lang.String&nbsp;lastState)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GMTimes</h4>
<pre>public&nbsp;GMTimes&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Long&gt;&nbsp;times)</pre>
</li>
</ul>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GMTimes</h4>
<pre>public&nbsp;GMTimes()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getGMKeyArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGMKeyArray</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String[]&nbsp;getGMKeyArray()</pre>
</li>
</ul>
<a id="magicNumberToGMName(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>magicNumberToGMName</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;magicNumberToGMName&#8203;(int&nbsp;magicNumber)</pre>
</li>
</ul>
<a id="getMostUsedGameMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMostUsedGameMode</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;java.lang.String&gt;&nbsp;getMostUsedGameMode()</pre>
</li>
</ul>
<a id="setAllGMTimes(long...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllGMTimes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAllGMTimes&#8203;(long...&nbsp;times)</pre>
<div class="block">Sets times for all 4 gamemodes.
<p>
Give 1 - 4 parameters.
times starts from Survival, ends in Spectator.
<p>
Given too few parameters (Under 4, rest are set as 0L)
Extra parameters are ignored (Over 4)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>times</code> - 1-4 time parameters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If any parameter is null.</dd>
</dl>
</li>
</ul>
<a id="resetTimes(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetTimes</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;resetTimes&#8203;(long&nbsp;time)</pre>
</li>
</ul>
<a id="getState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getState()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TimeKeeper.html#getState()">getState</a></code>&nbsp;in class&nbsp;<code><a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">TimeKeeper</a></code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TimeKeeper.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="TimeKeeper.html" title="class in com.djrapitops.plan.gathering.domain">TimeKeeper</a></code></dd>
</dl>
</li>
</ul>
<a id="toJson()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toJson</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toJson()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>