FixedTimeExecutor 1.5.0 API

All Implemented Interfaces:: org.polyfrost.polyui.utils.Clock.Executor


public class Clock.FixedTimeExecutor
 implements Clock.Executor

Create a new FixedTimeExecutor.

Since:: 0.18.1

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`cycles`
`private final Long`	`executeEveryNanos`
`private final Integer`	`repeats`

Constructor Summary

Constructors
Constructor	Description
`Clock.FixedTimeExecutor(Long executeEveryNanos, Integer repeats, Function0<Unit> func)`
`Clock.FixedTimeExecutor(Long executeEveryNanos, Function0<Unit> func)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getCycles()`	amount of times this has executed.
`final Long`	`getExecuteEveryNanos()`
`final Integer`	`getRepeats()`
`Long`	`tick(Long deltaTimeNanos)`	Update this Executor.

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

- Constructor Detail
  - Clock.FixedTimeExecutor
```
Clock.FixedTimeExecutor(Long executeEveryNanos, Integer repeats, Function0<Unit> func)
```
    Parameters:
    
    repeats - how many times to repeat before stopping.
  - Clock.FixedTimeExecutor
```
Clock.FixedTimeExecutor(Long executeEveryNanos, Function0<Unit> func)
```
- Method Detail
  - getCycles
```
 final Integer getCycles()
```
    amount of times this has executed. Only incremented when repeats is not 0 (i.e. it does not last forever) to prevent numerical overflow and keep method short.
  - getExecuteEveryNanos
```
 final Long getExecuteEveryNanos()
```
  - getRepeats
```
 final Integer getRepeats()
```
  - tick
```
 Long tick(Long deltaTimeNanos)
```
    Update this Executor.
    
    Returns:
    
    the time remaining until the next execution, or a negative number if it no longer needs to be executed and can be removed.