Scaleform Studio Lua API Reference: scaleform.TweenerModes enumeration reference

scaleform.TweenerModes enumeration reference

Description

An internal enumeration that controls behavior of tweeners.

Enumeration values

Indicates that the tweener interprets the value as frames.
Indicates that the tweener interprets the value as seconds.
 scaleform.Tweener.set_next_tweener (self, nextTweener, mode, dur, del, rev)
Sets the tweener that will be executed once this tweener finishes its job(creates a chain of tweeners).
 scaleform.Tweener.start (self, tweenerMode, duration, delay)
Starts the tween, if it is not already running.
 scaleform.TweenerModes.FramesMode
Indicates that the tweener interprets the value as frames.
 scaleform.TweenerModes.TimeMode
Indicates that the tweener interprets the value as seconds.
 self : scaleform.Tweener
The tweener currently in use.
 nextTweener : scaleform.Tweener
The next tweener to be executed.
 mode : scaleform.TweenerModes
The mode of the tweener.
 dur : number
Duration of the tween - How long a transition will take place.
 del : number?
Amount of time to delay the tween.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
 rev : boolean?
A flag to reverse the tween.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
 self : scaleform.Tweener
The tweener currently in use.
 tweenerMode : scaleform.TweenerModes
The mode of the tweener - time mode or frame mode.
 duration : number
How long a transition will take (in ms or frames).
 delay : number?
How much time the transition must wait before it starts.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
 scaleform.Tweener
A Lua interface to Tweener.
 scaleform.TweenerModes
An internal enumeration that controls behavior of tweeners.
A numeric value.true or false.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.