Scaleform Studio Lua API Reference: scaleform.AnimationComponent object reference
Description
Controls a timeline animation
Inheritance 
Related help topics
Functions
self : |
The animation component that the current frame will be gotten from. |
integer |
Returns the current frame number which is from 0 to num_frames - 1. |
self : |
The animation component that the number of available frames will be gotten from. |
table? |
Returns a table where the keys are the table names and the values are the frame numbers. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
self : |
The animation component that the current frame will be set for. | |
frame : | integer |
The frame number which goes from 1 to num_frames. |
| This function does not return any values. |
If the animation is playing it will continue playing.
self : |
The animation component that the current frame will be set for. | |
label : | string |
The label text assigned to a specific frame. |
| This function does not return any values. |
self : |
The animation component that the playback state will be returned from. |
boolean |
Returns true if the animation is player or false otherwise. |
self : |
The animation component that the number of available frames will be gotten from. |
integer |
Returns the number of available frames the animation has. |
self : |
The animation component that the number of frames will be gotten from. |
integer |
Returns the number of frames the animation has. |
self : |
The animation component that will pause |
| This function does not return any values. |
self : |
The animation component that will start playing. |
| This function does not return any values. |
It continues to play from the frame it previously was stopped (or, from the beginning).
self : |
The animation component that the current frame will be set for. | |
frame : | integer |
The frame number which goes from 1 to num_frames. |
| This function does not return any values. |
self : |
The animation component that the current frame will be set for. | |
label : | string |
The label text assigned to a specific frame. |
| This function does not return any values. |
self : |
The animation component that will resume playback. |
| This function does not return any values. |
self : |
The animation component that the current frame will be set for. | |
frame : | integer |
The frame number which goes from 1 to num_frames. |
| This function does not return any values. |
If the animation is playing it will continue playing. This function is deprecated. Use goto_frame instead.
self : |
The animation component that the current frame will be set for. | |
label : | string |
The label text assigned to a specific frame. |
| This function does not return any values. |
This function is deprecated. Use goto_label instead.
self : |
The animation component that will resume playback. |
| This function does not return any values. |
self : |
The animation component that the current frame will be set for. | |
frame : | integer |
The frame number which goes from 1 to num_frames. |
| This function does not return any values. |
scaleform.ComponentThe root type of all actor components.
scaleform.VisualComponentAn interface to the visual component.
scaleform.ContainerComponentAn interface to container component.
scaleform.AnimationComponent.current_frame (self) : integerGets the current frame of the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be gotten from.
integer scaleform.AnimationComponentControls a timeline animation A strictly integral numeric value, with no decimal component.
scaleform.AnimationComponent.frame_labels (self) : table?Gets the labels and their frame numbers for the current timeline.
self : scaleform.AnimationComponentThe animation component that the number of available frames will be gotten from.
table? scaleform.AnimationComponent.goto_frame (self, frame) Set the current frame of the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
frame : integerThe frame number which goes from 1 to num_frames.
scaleform.AnimationComponent.goto_label (self, label) Set the current frame of the animation to the frame with the given label.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
label : stringThe label text assigned to a specific frame.A string of characters.
scaleform.AnimationComponent.is_playing (self) : booleanGet whether the animation component is playing or not.
self : scaleform.AnimationComponentThe animation component that the playback state will be returned from.
booleantrue or false. scaleform.AnimationComponent.num_available_frames (self) : integerGets the number of frames of the animation which are loaded and thus are readily available.
self : scaleform.AnimationComponentThe animation component that the number of available frames will be gotten from.
integer scaleform.AnimationComponent.num_frames (self) : integerGets the number of frames of the animation.
self : scaleform.AnimationComponentThe animation component that the number of frames will be gotten from.
integer scaleform.AnimationComponent.pause (self) Pauses animation for this object.
self : scaleform.AnimationComponentThe animation component that will pause
scaleform.AnimationComponent.play (self) Starts playing timeline, if it exists.
self : scaleform.AnimationComponentThe animation component that will start playing.
scaleform.AnimationComponent.play_frame (self, frame) Set the current frame and plays the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
frame : integerThe frame number which goes from 1 to num_frames.
scaleform.AnimationComponent.play_label (self, label) Set the current frame at the given label and plays the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
label : stringThe label text assigned to a specific frame.
scaleform.AnimationComponent.resume (self) Resumes playback after pausing.
self : scaleform.AnimationComponentThe animation component that will resume playback.
scaleform.AnimationComponent.set_current_frame (self, frame) Set the current frame of the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
frame : integerThe frame number which goes from 1 to num_frames.
scaleform.AnimationComponent.set_current_label (self, label) Set the current frame of the animation to the frame with the given label.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
label : stringThe label text assigned to a specific frame.
scaleform.AnimationComponent.stop (self) Stops playback after pausing.
self : scaleform.AnimationComponentThe animation component that will resume playback.
scaleform.AnimationComponent.stop_frame (self, frame) Set the current frame and stops the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
frame : integerThe frame number which goes from 1 to num_frames.
scaleform.AnimationComponent.stop_label (self, label) Set the current frame at the given label and stops the animation.
self : scaleform.AnimationComponentThe animation component that the current frame will be set for.
label : stringThe label text assigned to a specific frame.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.