Skip to content

Timer

Timer is an object type. You don't create it directly: you get one from another call, then call its methods with a colon, e.g. timer:name().

Methods

Function Description Since
name() Get / Set the timer name. 1.1.0
direction() Get / Set the timer direction (1 / -1) 1.1.0
persistent() Get / Set the timer persistent attribute. 26.1.0
value() Get / Set the timer value. 1.1.0
stringValue() Return the timer value as a string. 1.5.8
alarm() Get / Set the alarm value of the timer. 1.1.0
start() Get / Set the start value of the timer. 1.1.0
startCondition() Get / Set the start condition of the timer. 1.1.0
stopCondition() Get / Set the stop condition of the timer. 26.1.0
countingSource() Get / Set the counting source of the timer. 26.1.0
voice() Get / Set the voice used by the timer. 26.1.0
audioActions() Get / Set the audio actions of the timer. 1.5.0
resetCondition() Get / Set the reset condition of the timer. 1.1.0
reset() Reset the timer. 1.4.10
running() Return the running state of the timer. 1.5.0