Scaleform Studio Lua API Reference: scaleform.TimerBase object reference
scaleform.TimerBase object reference
Description
An interface to timer objects.
Inheritance 
Related help topics
Functions
Parameters
Returns
self : |
The timer currently in use. |
boolean |
Returns true if the timer is active and false otherwise. |
Parameters
Returns
self : |
The timer currently in use. |
| This function does not return any values. |
 |
clear_all ( )
Deactivates all available timers.
|
Parameters
Returns
| This function does not accept any parameters. |
| This function does not return any values. |
Parameters
Returns
self : |
The timer whose id is returned. |
integer |
The id associated with the timer. |
Parameters
Returns
self : |
The timer currently in use. |
boolean |
Returns true if the timer invokes the function and false otherwise. |
Parameters
Returns
self : |
The timer currently in use. |
number |
Time in microseconds. |
Parameters
Returns
self : |
The timer whose id is set. | |
id : | integer |
The id assigned to the timer. |
| This function does not return any values. |
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.TimerRepresents a timer.
scaleform.TweenerA Lua interface to Tweener.
scaleform.TimerBase.active (self) : booleanDetermines if the timer is active or not.
self : scaleform.TimerBaseThe timer currently in use.
boolean scaleform.TimerBaseAn interface to timer objects. true or false.
scaleform.TimerBase.clear (self) Deactivates the timer.
self : scaleform.TimerBaseThe timer currently in use.
scaleform.TimerBase.clear_all () Deactivates all available timers.
scaleform.TimerBase.id (self) : integerReturns the id assigned to the timer.
self : scaleform.TimerBaseThe timer whose id is returned.
integerA strictly integral numeric value, with no decimal component. scaleform.TimerBase.invoke (self) : booleanImmediately invoke the timer which will dispatch the next appropriate timer event.
self : scaleform.TimerBaseThe timer currently in use.
boolean scaleform.TimerBase.next_invoke_time (self) : numberGets the next invoke time for the timer.
self : scaleform.TimerBaseThe timer currently in use.
numberTime in microseconds.A numeric value.
scaleform.TimerBase.set_id (self, id) Sets an id to the timer.
self : scaleform.TimerBaseThe timer whose id is set.
id : integerThe id assigned to the timer.
scaleform.TimerBase.timer_type (self) : scaleform.TimerTypesReturns the type of timer.
self : scaleform.TimerBaseThe timer base available.
scaleform.TimerTypesThe type of the timer.
scaleform.TimerTypesThe types of timers. 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.