TimerComponent constructor
TimerComponent({
- required double period,
- bool repeat = false,
- bool autoStart = true,
- bool removeOnFinish = false,
- VoidCallback? onTick,
- bool tickWhenLoaded = false,
- ComponentKey? key,
Creates a TimerComponent
period
The period of time in seconds that the tick will be called
repeat
When true, this will continue running after period
is reached
autoStart
When true, will start upon instantiation (default is true)
onTick
When provided, will be called every time period
is reached.
This overrides the onTick
method
tickWhenLoaded
When true, will call onTick
when the component is first
loaded (default is false).
Implementation
TimerComponent({
required double period,
bool repeat = false,
bool autoStart = true,
this.removeOnFinish = false,
VoidCallback? onTick,
this.tickWhenLoaded = false,
super.key,
}) : _onTick = onTick {
timer = Timer(
period,
repeat: repeat,
onTick: this.onTick,
autoStart: autoStart,
);
}