IntervalUtil

java.lang.Object
- com.fs.starfarer.api.util.IntervalUtil

```
public class IntervalUtil
extends java.lang.Object
```
Timer utility that fires at a random interval between minInterval and maxInterval.
To use, call intervalUtil.advance(float amount); in an advance(float amount) method (i.e. every frame). Then, call intervalUtil.intervalElapsed() each frame to check if the timer has elapsed.
It automatically resets itself after it elapses.

Constructor Summary

Constructors
Constructor and Description

IntervalUtil(float minInterval, float maxInterval)
Timer utility that fires at a random interval between minInterval and maxInterval.

Constructors
Constructor and Description
`IntervalUtil(float minInterval, float maxInterval)` Timer utility that fires at a random interval between minInterval and maxInterval.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`advance(float amount)`
`void`	`forceCurrInterval(float value)`
`void`	`forceIntervalElapsed()`
`float`	`getElapsed()`
`float`	`getIntervalDuration()`
`float`	`getMaxInterval()`
`float`	`getMinInterval()`
`java.util.Random`	`getRandom()`
`boolean`	`intervalElapsed()` Returns true once and only once when the current interval is over.
`void`	`nextInterval()`
`void`	`randomize()`
`void`	`setElapsed(float elapsed)`
`void`	`setInterval(float min, float max)`
`void`	`setRandom(java.util.Random random)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IntervalUtil
```
public IntervalUtil(float minInterval,
                    float maxInterval)
```
    Timer utility that fires at a random interval between minInterval and maxInterval.
    To use, call intervalUtil.advance(float amount); in an advance(float amount) method (i.e. every frame). Then, call intervalUtil.intervalElapsed() each frame to check if the timer has elapsed.
    It automatically resets itself after it elapses.
    
    Parameters:
    
    minInterval - minimum duration of the timer, in seconds
    
    maxInterval - maximum duration of the timer, in seconds
- Method Detail
  - forceCurrInterval
```
public void forceCurrInterval(float value)
```
  - getRandom
```
public java.util.Random getRandom()
```
  - setRandom
```
public void setRandom(java.util.Random random)
```
  - randomize
```
public void randomize()
```
  - forceIntervalElapsed
```
public void forceIntervalElapsed()
```
  - getElapsed
```
public float getElapsed()
```
  - nextInterval
```
public void nextInterval()
```
  - advance
```
public void advance(float amount)
```
  - intervalElapsed
```
public boolean intervalElapsed()
```
    Returns true once and only once when the current interval is over. Must be called every frame, otherwise the time it returns true might be missed.
    
    Returns:
  - getIntervalDuration
```
public float getIntervalDuration()
```
  - setInterval
```
public void setInterval(float min,
                        float max)
```
  - setElapsed
```
public void setElapsed(float elapsed)
```
  - getMinInterval
```
public float getMinInterval()
```
  - getMaxInterval
```
public float getMaxInterval()
```

Class IntervalUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntervalUtil

Method Detail

forceCurrInterval

getRandom

setRandom

randomize

forceIntervalElapsed

getElapsed

nextInterval

advance

intervalElapsed

getIntervalDuration

setInterval

setElapsed

getMinInterval

getMaxInterval