Parameters
Returns
self : |
The timer to start. |
| This function does not return any values. |
Scaleform Studio Lua API Reference: scaleform.Timer object reference
scaleform.Timer object reference
Description
Represents a timer.
Inheritance 
Constructors and accessors
Related help topics
Functions
Parameters
Returns
| This function does not accept any parameters. |
|
The newly created Timer. |
Parameters
Returns
self : |
The timer to reset. |
| This function does not return any values. |
Parameters
Returns
self : |
The timer whose values are set. | |
delay : | number |
How long to wait to start the timer. |
repeat : | integer? |
The repeat count of the timer. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
boolean |
Returns true if the timer is set and false otherwise. |
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.TimerBaseAn interface to timer objects.
scaleform.Timer.create () : scaleform.TimerCreates a new Timer.
scaleform.TimerThe newly created Timer.
scaleform.TimerRepresents a timer.
scaleform.Timer.reset (self) Stops the timer, if it is running, and resets the count back to 0.
self : scaleform.TimerThe timer to reset.
scaleform.Timer.set_timer (self, delay, repeat) : booleanSets the timer values.
self : scaleform.TimerThe timer whose values are set.
delay : numberHow long to wait to start the timer.
repeat : integer?The repeat count of the timer.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
booleanA numeric value.A strictly integral numeric value, with no decimal component.true or false. scaleform.Timer.start (self) Starts the timer if it is not already running.
self : scaleform.TimerThe timer to start.
scaleform.Timer.stop (self) Stops the timer.
self : scaleform.TimerThe timer to stop.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.