mirror/Slimefun4
mirror/Slimefun4
1
Fork 0
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 11:45:51 +00:00
Code Releases Activity
96179d9d36
Slimefun4/docs/me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html

374 lines
18 KiB
HTML
Raw Normal View History

[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
[CI skip] Refactoring, documentation, reduced technical debt
2020-03-07 13:52:33 +00:00
<!-- Generated by javadoc (1.8.0_111) on Sat Mar 07 14:51:37 CET 2020 -->
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
<title>RainbowTicker</title>
[CI skip] Updated javadocs
2020-03-06 23:22:11 +00:00
<meta name="date" content="2020-03-07">
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00: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) {
parent.document.title="RainbowTicker";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
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";
</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="class-use/RainbowTicker.html">Use</a></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="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html" target="_top">Frames</a></li>
<li><a href="RainbowTicker.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><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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">me.mrCookieSlime.Slimefun.Objects.handlers</div>
<h2 title="Class RainbowTicker" class="title">Class RainbowTicker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">me.mrCookieSlime.Slimefun.Objects.handlers.BlockTicker</a></li>
<li>
<ul class="inheritance">
<li>me.mrCookieSlime.Slimefun.Objects.handlers.RainbowTicker</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RainbowTicker</span>
extends <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">BlockTicker</a></pre>
<div class="block">This is a <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers"><code>BlockTicker</code></a> that is exclusively used for Rainbow blocks.
On every tick it cycles through the <code>LoopIterator</code> and chooses the next <a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html?is-external=true" title="class or interface in org.bukkit"><code>Material</code></a>
and sets itself to that.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>TheBusyBiscuit</dd>
[CI skip] Refactoring + documentation
2020-03-06 00:57:50 +00:00
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../io/github/thebusybiscuit/slimefun4/implementation/items/blocks/RainbowBlock.html" title="class in io.github.thebusybiscuit.slimefun4.implementation.items.blocks"><code>RainbowBlock</code></a></dd>
[CI skip] Refactoring + Added Javadocs
2020-03-05 20:28:50 +00:00
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html#RainbowTicker-org.bukkit.Material...-">RainbowTicker</a></span>(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html?is-external=true" title="class or interface in org.bukkit">Material</a>...&nbsp;materials)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html#RainbowTicker-io.github.thebusybiscuit.cscorelib2.materials.MaterialCollection-">RainbowTicker</a></span>(io.github.thebusybiscuit.cscorelib2.materials.MaterialCollection&nbsp;collection)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html#isSynchronized--">isSynchronized</a></span>()</code>
<div class="block">This method must be overridden to define whether a Block
needs to be run on the main server thread (World Manipulation requires that)</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html#tick-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config-">tick</a></span>(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item,
me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config&nbsp;data)</code>
<div class="block">This method is called every tick for every block</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html#uniqueTick--">uniqueTick</a></span>()</code>
<div class="block">This method is called every tick but not per-block and only once.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.me.mrCookieSlime.Slimefun.Objects.handlers.BlockTicker">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;me.mrCookieSlime.Slimefun.Objects.handlers.<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">BlockTicker</a></h3>
<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#getIdentifier--">getIdentifier</a>, <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#startNewTick--">startNewTick</a>, <a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#update--">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;me.mrCookieSlime.Slimefun.Objects.handlers.<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers">ItemHandler</a></h3>
<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/ItemHandler.html#isPrivate--">isPrivate</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RainbowTicker-org.bukkit.Material...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RainbowTicker</h4>
<pre>public&nbsp;RainbowTicker(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html?is-external=true" title="class or interface in org.bukkit">Material</a>...&nbsp;materials)</pre>
</li>
</ul>
<a name="RainbowTicker-io.github.thebusybiscuit.cscorelib2.materials.MaterialCollection-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RainbowTicker</h4>
<pre>public&nbsp;RainbowTicker(io.github.thebusybiscuit.cscorelib2.materials.MaterialCollection&nbsp;collection)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="tick-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tick</h4>
<pre>public&nbsp;void&nbsp;tick(<a href="https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html?is-external=true" title="class or interface in org.bukkit.block">Block</a>&nbsp;b,
<a href="../../../../../me/mrCookieSlime/Slimefun/Objects/SlimefunItem/SlimefunItem.html" title="class in me.mrCookieSlime.Slimefun.Objects.SlimefunItem">SlimefunItem</a>&nbsp;item,
me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config&nbsp;data)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#tick-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config-">BlockTicker</a></code></span></div>
<div class="block">This method is called every tick for every block</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#tick-org.bukkit.block.Block-me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem-me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config-">tick</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">BlockTicker</a></code></dd>
</dl>
</li>
</ul>
<a name="uniqueTick--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uniqueTick</h4>
<pre>public&nbsp;void&nbsp;uniqueTick()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#uniqueTick--">BlockTicker</a></code></span></div>
<div class="block">This method is called every tick but not per-block and only once.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#uniqueTick--">uniqueTick</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">BlockTicker</a></code></dd>
</dl>
</li>
</ul>
<a name="isSynchronized--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isSynchronized</h4>
<pre>public&nbsp;boolean&nbsp;isSynchronized()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#isSynchronized--">BlockTicker</a></code></span></div>
<div class="block">This method must be overridden to define whether a Block
needs to be run on the main server thread (World Manipulation requires that)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html#isSynchronized--">isSynchronized</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/BlockTicker.html" title="class in me.mrCookieSlime.Slimefun.Objects.handlers">BlockTicker</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether this task should run on the main server thread</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="class-use/RainbowTicker.html">Use</a></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="../../../../../me/mrCookieSlime/Slimefun/Objects/handlers/MultiBlockInteractionHandler.html" title="interface in me.mrCookieSlime.Slimefun.Objects.handlers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?me/mrCookieSlime/Slimefun/Objects/handlers/RainbowTicker.html" target="_top">Frames</a></li>
<li><a href="RainbowTicker.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><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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Copy Permalink