mirror of
https://github.com/KAMKEEL/CustomNPC-Plus.git
synced 2026-11-12 17:47:32 +00:00
456 lines
16 KiB
HTML
456 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_331) on Tue Aug 16 13:33:15 CDT 2022 -->
|
|
<title>ITimers</title>
|
|
<meta name="date" content="2022-08-16">
|
|
<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) {
|
|
parent.document.title="ITimers";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../noppes/npcs/scripted/interfaces/IWorld.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?noppes/npcs/scripted/interfaces/ITimers.html" target="_top">Frames</a></li>
|
|
<li><a href="ITimers.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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">noppes.npcs.scripted.interfaces</div>
|
|
<h2 title="Interface ITimers" class="title">Interface ITimers</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">ITimers</span></pre>
|
|
</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#clear--">clear</a></span>()</code>
|
|
<div class="block">Removes all timers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#forceStart-int-int-boolean-">forceStart</a></span>(int id,
|
|
int ticks,
|
|
boolean repeat)</code>
|
|
<div class="block">Adds a timer to the NPC or player with the given attributes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#has-int-">has</a></span>(int id)</code> </td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#maxTicks-int-">maxTicks</a></span>(int id)</code> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#repeats-int-">repeats</a></span>(int id)</code> </td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#reset-int-">reset</a></span>(int id)</code>
|
|
<div class="block">Resets the ticks elapsed in the timer with the given id to 0.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#setMaxTicks-int-int-">setMaxTicks</a></span>(int id,
|
|
int maxTicks)</code>
|
|
<div class="block">Sets the maximum amount of ticks the timer with the given id can run for before it stops.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#setRepeats-int-boolean-">setRepeats</a></span>(int id,
|
|
boolean repeat)</code>
|
|
<div class="block">Sets whether the timer with the given id repeats or not.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#setTicks-int-int-">setTicks</a></span>(int id,
|
|
int ticks)</code>
|
|
<div class="block">Sets the amount of ticks elapsed in the timer with the given id to a different value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#size--">size</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#start-int-int-boolean-">start</a></span>(int id,
|
|
int ticks,
|
|
boolean repeat)</code>
|
|
<div class="block">Adds a timer to the NPC or player with the given attributes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#stop-int-">stop</a></span>(int id)</code>
|
|
<div class="block">Stops the timer with the given id</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../noppes/npcs/scripted/interfaces/ITimers.html#ticks-int-">ticks</a></span>(int id)</code> </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="start-int-int-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>start</h4>
|
|
<pre>void start(int id,
|
|
int ticks,
|
|
boolean repeat)</pre>
|
|
<div class="block">Adds a timer to the NPC or player with the given attributes. If this function is used and there is already a
|
|
timer with the given ID, an exception will be thrown.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The id of the timer.</dd>
|
|
<dd><code>ticks</code> - The amount of ticks before the timer ends.</dd>
|
|
<dd><code>repeat</code> - Whether this timer repeats when it reaches its maximum amount of ticks.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="forceStart-int-int-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>forceStart</h4>
|
|
<pre>void forceStart(int id,
|
|
int ticks,
|
|
boolean repeat)</pre>
|
|
<div class="block">Adds a timer to the NPC or player with the given attributes. No exception will be thrown if there is already a
|
|
timer with the given ID when using this function.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The id of the timer.</dd>
|
|
<dd><code>ticks</code> - The amount of ticks before the timer ends.</dd>
|
|
<dd><code>repeat</code> - Whether this timer repeats when it reaches its maximum amount of ticks.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="has-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>has</h4>
|
|
<pre>boolean has(int id)</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the set of timers contains a timer with the given id, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="stop-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>stop</h4>
|
|
<pre>boolean stop(int id)</pre>
|
|
<div class="block">Stops the timer with the given id</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if there was a timer with the given id.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="reset-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>reset</h4>
|
|
<pre>void reset(int id)</pre>
|
|
<div class="block">Resets the ticks elapsed in the timer with the given id to 0.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="clear--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clear</h4>
|
|
<pre>void clear()</pre>
|
|
<div class="block">Removes all timers.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="ticks-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>ticks</h4>
|
|
<pre>int ticks(int id)</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The amount of ticks elapsed in the timer.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTicks-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTicks</h4>
|
|
<pre>void setTicks(int id,
|
|
int ticks)</pre>
|
|
<div class="block">Sets the amount of ticks elapsed in the timer with the given id to a different value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>ticks</code> - The new ticks elapsed by the timer.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="maxTicks-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>maxTicks</h4>
|
|
<pre>int maxTicks(int id)</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum amount of ticks the timer with the given id runs for before it stops.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxTicks-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxTicks</h4>
|
|
<pre>void setMaxTicks(int id,
|
|
int maxTicks)</pre>
|
|
<div class="block">Sets the maximum amount of ticks the timer with the given id can run for before it stops.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="repeats-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>repeats</h4>
|
|
<pre>boolean repeats(int id)</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the timer with the given id repeats, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRepeats-int-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRepeats</h4>
|
|
<pre>void setRepeats(int id,
|
|
boolean repeat)</pre>
|
|
<div class="block">Sets whether the timer with the given id repeats or not.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="size--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>size</h4>
|
|
<pre>int size()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The amount of timers in the set of timers.</dd>
|
|
</dl>
|
|
</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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../noppes/npcs/scripted/interfaces/ITileEntity.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../noppes/npcs/scripted/interfaces/IWorld.html" title="interface in noppes.npcs.scripted.interfaces"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?noppes/npcs/scripted/interfaces/ITimers.html" target="_top">Frames</a></li>
|
|
<li><a href="ITimers.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|