Package forestry.api.util

Class TickHelper

java.lang.Object

forestry.api.util.TickHelper

public final class TickHelper
extends Object

Helper object used to execute update logic on every tick interval.

Constructor Summary

Constructors

Constructor	Description
TickHelper(int offset)	Create a new tick helper.

Method Summary

Modifier and Type	Method	Description
void	onTick()	Must be called every tick to keep track of the total number of ticks.
boolean	updateOnInterval(int tickInterval)	Used to check if a certain number of ticks has elapsed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TickHelper

public TickHelper(int offset)

Create a new tick helper.

Parameters:

offset - A random offset used to avoid other TickHelpers on the same interval all ticking at the same time.

Method Details

onTick

public void onTick()

Must be called every tick to keep track of the total number of ticks.

updateOnInterval

public boolean updateOnInterval(int tickInterval)

Used to check if a certain number of ticks has elapsed.

Parameters:

tickInterval - The tick interval for which this method should return true. For example, a tickInterval of 60 would return true every three seconds.

Returns:

Whether enough ticks have elapsed since the last time this method returned true.