Class Timer
Inheritance
| Component | Timer 🡄 Component 🡄 Object |
Properties
| Enabled | |
| Interval | The number of milliseconds (1000=1 second) between executions. |
| OnTimer | The function to call when the timer triggers. |
Methods
| getEnabled () | |
| getInterval () | |
| getOnTimer () | |
| setEnabled ( enabled, enabled ) | |
| setInterval ( interval ) | Sets the speed on how often the timer should trigger. |
| setOnTimer ( func ) |
Creation
| createTimer ( owner, enabled ) | Creates a timer object. |
Inheritance
Properties
- Enabled
-
Type:
boolean - Interval
-
The number of milliseconds (1000=1 second) between executions.
Type:
integer - OnTimer
-
The function to call when the timer triggers.
Type:
functionUsage:
Timer.OnTimer = function(timer)
Methods
- getEnabled ()
-
Returns:
-
boolean
- getInterval ()
-
Returns:
-
integer
- getOnTimer ()
- setEnabled ( enabled, enabled )
-
Parameters:
- enabled boolean
- enabled boolean
- setInterval ( interval )
-
Sets the speed on how often the timer should trigger.
In milliseconds (1000=1 second).
Parameters:
- interval integer
- setOnTimer ( func )
-
Parameters:
- func function
Usage:
Timer.setOnTimer(function(time))
Creation
- createTimer ( owner, enabled )
-
Creates a timer object.
If enabled is not given it will be enabled by default (will start as
soon as an onTimer event has been assigned). Owner may be nil, but
you will be responsible for destroying it instead of being the
responsibility of the owner object.
Parameters:
- owner (optional)
- enabled (optional)