Scaleform Studio Lua API Reference: scaleform.Tweener object reference
A Lua interface to Tweener.
This element inherits from:
Parameters self : | scaleform.Tweener |
The tweener to which a new property is added.
|
actor : | scaleform.Actor |
The actor.
|
id : | string |
The Id of the property.
|
propValue : | any |
The property value/initial value.
|
finalValue : | any? |
The final value of the property.
The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Returns | This function does not return any values. |
If only the final value of the property is specified
then the initial value is the current state of the property.
Parameters | This function does not accept any parameters. |
Returns
Parameters Returns integer |
The current frame index.
|
Parameters Returns number |
the current time in ms.
|
Parameters Returns number |
The delay duration of the tween.
|
If the tween is frame-based, it returns the
number of frames;otherwise returns time in milliseconds.
Parameters Returns number |
The duration of the tween in frames/time in ms.
|
If the tween is frame-based, it returns the
number of frames;otherwise returns time in milliseconds.
Parameters Returns string |
The type of tween equation set.
|
Parameters Returns number |
Number of frames per second.
|
Parameters self : | scaleform.Tweener |
The tweener currently in use.
|
index : | integer |
The frame to move the tween to.
|
Returns boolean |
Whether the playhead is moved to frame or not.
|
Parameters Returns boolean |
Whether the playhead is moved to next frame or not.
|
Parameters Returns boolean |
Whether the playhead is moved to previous frame or not.
|
Parameters self : | scaleform.Tweener |
The tweener currently in use.
|
time : | number |
The time to move the tween to in ms
|
Returns boolean |
Whether the playhead is moved to the time or not.
|
Parameters Returns integer |
The repeat counter of the tween.
|
Parameters Returns integer |
The reverse counter of the tween.
|
Parameters Returns table |
A table of tween properties.
|
Parameters Returns | This function does not return any values. |
Parameters Returns | This function does not return any values. |
Parameters Returns | This function does not return any values. |
Parameters self : | scaleform.Tweener |
The tweener whose equation is set.
|
eqnType : | string |
The type of equation to apply.
|
Returns | This function does not return any values. |
Parameters self : | scaleform.Tweener |
The tweener currently in use.
|
frame : | number |
Number of frames to be updated per second.
|
Returns | This function does not return any values. |
Parameters 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. |
Returns | This function does not return any values. |
Parameters self : | scaleform.Tweener |
The tweener whose equation is set.
|
repeatCount : | integer |
The counter value.
|
reverse : | boolean |
A flag to reverse the counter.
|
Returns | This function does not return any values. |
Parameters Returns | This function does not return any values. |
Parameters self : | scaleform.Tweener |
The tweener whose property is set.
|
customEasing : | table |
A table that has custom easing functions.
|
Returns | This function does not return any values. |
Parameters 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. |
Returns | This function does not return any values. |
Parameters Returns | This function does not return any values. |
Parameters Returns boolean |
Returns true if tweener uses frames and false otherwise.
|
scaleform.EventDispatcher
The base object for managing event listeners and dispatching events to the listeners.
scaleform.TimerBase
An interface to timer objects.
scaleform.Tweener.create () : scaleform.Tweener
Creates a new Tweener.
scaleform.Tweener.next_tweener (self) : scaleform.Tweener
Returns the tweener that will be executed once this tweener finishes its job.
scaleform.Tweener.add_property (self, actor, id, propValue, finalValue)
Add a property for tween.
self : scaleform.Tweener
The tweener to which a new property is added. actor : scaleform.Actor
The actor. id : string
The Id of the property. propValue : any
The property value/initial value. finalValue : any?
The final value of the property.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.Actor
Generic objects located in a scene.
A string of characters.This value may be an instance of any type.
scaleform.Tweener
The newly created Tweener. scaleform.Tweener.current_frame (self) : integer
Returns the current frame index of the tween.
self : scaleform.Tweener
The tweener currently in use. integerA strictly integral numeric value, with no decimal component. scaleform.Tweener.current_time (self) : number
returns the current time of the tween.
self : scaleform.Tweener
The tweener currently in use. number
the current time in ms.A numeric value. scaleform.Tweener.delay (self) : number
Returns the start delay duration.
self : scaleform.Tweener
The tweener currently in use. number scaleform.Tweener.duration (self) : number
Returns the duration of the tween.
self : scaleform.Tweener
The tweener currently in use. number scaleform.Tweener.equation (self) : string
Returns equation for the tween.
self : scaleform.Tweener
The tweener whose equation is set. string scaleform.Tweener.fps (self) : number
Returns the currently set frames per second rate.
self : scaleform.Tweener
The tweener currently in use. number scaleform.Tweener.goto_frame_by_index (self, index) : boolean
Moves a 'virtual playhead' to specified position.
self : scaleform.Tweener
The tweener currently in use. index : integer
The frame to move the tween to. booleantrue or false. scaleform.Tweener.goto_next_frame (self) : boolean
Moves a 'virtual playhead' to the next frame.
self : scaleform.Tweener
The tweener currently in use. boolean scaleform.Tweener.goto_previous_frame (self) : boolean
Moves a 'virtual playhead' to previous frame.
self : scaleform.Tweener
The tweener currently in use. boolean scaleform.Tweener.goto_time (self, time) : boolean
Moves a 'virtual playhead' to specified position.
self : scaleform.Tweener
The tweener currently in use. time : number
The time to move the tween to in ms boolean self : scaleform.Tweener
The tweener currently in use. scaleform.Tweener
The next tweener that is executed. scaleform.Tweener.num_repeats (self) : integer
Returns the repeat counter of the tween.
self : scaleform.Tweener
The tweener currently in use. integer scaleform.Tweener.num_reverses (self) : integer
Returns the reverse counter.
self : scaleform.Tweener
The tweener currently in use. integer scaleform.Tweener.properties (self) : table
Returns a table of tween properties.
self : scaleform.Tweener
The tweener currently in use. tableA Lua table consisting of paired keys and values. scaleform.Tweener.resume (self)
Resumes the tween.
self : scaleform.Tweener
The tweener currently in use. scaleform.Tweener.reverse (self)
Stops the tween and reverse it.
self : scaleform.Tweener
The tweener currently in use. scaleform.Tweener.rewind (self)
Stops the tween and reset it to the beginning.
self : scaleform.Tweener
The tweener currently in use. scaleform.Tweener.set_equation (self, eqnType)
Sets the equation for the tween.
self : scaleform.Tweener
The tweener whose equation is set. eqnType : string
The type of equation to apply. scaleform.Tweener.set_fps (self, frame)
Sets frequency of tween update as frames per second.
self : scaleform.Tweener
The tweener currently in use. frame : number
Number of frames to be updated per second. 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).
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.
scaleform.TweenerModes
An internal enumeration that controls behavior of tweeners.
scaleform.Tweener.set_repeat_with_reverse (self, repeatCount, reverse)
Sets repeat counter with reverse flag.
self : scaleform.Tweener
The tweener whose equation is set. repeatCount : integer
The counter value. reverse : boolean
A flag to reverse the counter. scaleform.Tweener.set_transition (self, easingType)
Sets the easing transition function.
self : scaleform.Tweener
The tweener whose property is set. easingType : scaleform.EasingTypes
The type of easing transition to apply. scaleform.EasingTypes
The type of easing performed.
scaleform.Tweener.set_transition (self, customEasing)
Sets the easing transition function.
self : scaleform.Tweener
The tweener whose property is set. customEasing : table
A table that has custom easing functions. scaleform.Tweener.start (self, tweenerMode, duration, delay)
Starts the tween, if it is not already running.
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.stop (self)
Stops the tween.
self : scaleform.Tweener
The tweener currently in use. scaleform.Tweener.transition (self) : scaleform.Easing
Returns the transition (easing) set on the tween.
self : scaleform.Tweener
The tweener whose property is set. scaleform.Easing
Returns the easing function object. scaleform.Easing
Represents an easing functor.
scaleform.Tweener.tweener_mode (self) : scaleform.TweenerModes
Returns the tweener mode.
self : scaleform.Tweener
The tweener currently in use. scaleform.TweenerModes
The tweener mode. scaleform.Tweener.uses_frames (self) : boolean
Checks and returns true if the tweener uses frame as counter.
self : scaleform.Tweener
The tweener currently in use. booleanIndicates 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.
