Scaleform Studio Lua API Reference: scaleform.Actor object reference

scaleform.Actor object reference
Functions
expand all | collapse all

Description

Generic objects located in a scene.

Functions

Parameters

self :

scaleform.Actor

The actor from which to start the relative path search.

path :

string

The name path of the object to find.

Returns

scaleform.Actor?

The object at the given path, or nil if one is not found.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor to which a component is added.

comp :

scaleform.Component

The component to add.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose alpha transparency is retrieved.

Returns

number

The alpha transparency value [0-1.0].

Parameters

self :

scaleform.Actor

The actor whose ancestry is checked for.

child :

scaleform.Actor

The actor whose ancestor is checked.

Returns

boolean

Returns true if this actor is an ancestor of the specified actor.

Parameters

self :

scaleform.Actor

The actor to rotate.

angle :

number

The angle with which to rotate (in degrees).

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to rotate.

xrot :

number

The angle with which to rotate along the X axis.

yrot :

number

The angle with which to rotate along the Y axis.

zrot :

number

The angle with which to rotate along the Z axis.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor which is scaled.

scale :

scaleform.Point

The scale factor for scaling relatively.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor which is scaled.

scale :

scaleform.Point3

The scale factor for scaling relatively.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose blend descriptor is retrieved.

Returns

table

The blend descriptor of the actor.

Parameters

self :

scaleform.Actor

The actor whose blend mode is retrieved.

Returns

scaleform.BlendModes

The blend mode (BlendMode) of the actor.

Parameters

self :

scaleform.Actor

The actor whose bounds is retrieved.

matrix :

Matrix2F

The transformation matrix used for calculating the bounding rectangle.

Returns

scaleform.Rect?

A rectangle representing character bounds in the coordinate space.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose component is retrieved.

index :

integer

The index into the component list from 1 to number of components.

Returns

scaleform.Component

The specified component.

Parameters

self :

scaleform.Actor

The actor whose component is retrieved.

name :

string

The name of the component of this actor.

Returns

scaleform.Component

The specified component of the actor.

Parameters

self :

scaleform.Actor

The actor to which color transformation is concatenated.

cxform :

scaleform.Cxform

The color transform matrix to concatenate.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to which a matrix is concatenated.

matrix :

Matrix2F

The matrix to concatenate.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor which is checked.

Returns

scaleform.ContainerComponent

The container component.

Parameters

parent :

scaleform.ContainerComponent?

The parent container.

The ? notation indicates that this type is optional: there may be zero or one instances of it.

components :

any(table,table[])?

The children components to create- either a single Object table, or an array of Object tables.

The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns

scaleform.Actor

The newly created Actor.

Parameters

self :

scaleform.Actor

The actor whose color transformation is retrieved.

Returns

scaleform.Cxform

The color transformation matrix.

Parameters

self :

scaleform.Actor

The actor whose dimension is retrieved.

Returns

scaleform.Size

The dimension set for the actor.

Parameters

self :

scaleform.Actor

The actor whose anti-aliasing mode is retrieved.

Returns

scaleform.EdgeAAModes

Returns the anti-aliasing mode set for the actor, scaleform.EdgeAAModes.

Parameters

self :

scaleform.Actor

The actor whose filters is set.

Returns

scaleform.FilterSet

Returns a set of the filters applied.

Parameters

self :

scaleform.Actor

The actor checked to determine whether a 3D transform is applied.

Returns

boolean

Returns true if the 3D transform is applied and false otherwise.

Parameters

self :

scaleform.Actor

The actor whose mask is set.

Returns

boolean

Returns true if a mask is applied and false otherwise.

Parameters

self :

scaleform.Actor

The actor which is checked.

Returns

boolean

Returns true if a scale9grid is applied and false otherwise.

Parameters

self :

scaleform.Actor

The actor which is checked.

Returns

boolean

Returns true if the actor is a container and false otherwise.

Parameters

self :

scaleform.Actor

The actor to check if it is a mask.

Returns

boolean

Returns true if the actor is set as a mask and false otherwise.

Parameters

self :

scaleform.Actor

The actor which is checked.

Returns

boolean

Returns true if the actor is a scene and false otherwise.

Parameters

self :

scaleform.Actor

The actor to check if it has been shutdown.

Returns

boolean

The shutdown state of the actor.

Parameters

self :

scaleform.Actor

The actor whose tab index is returned

Returns

boolean

Returns true if the actor is selectable by 'Tab' key.

Parameters

filePath :

string

The path of a .s2dscene or .s2dactor file to load.

Returns

scaleform.Actor

The top level actor created from the file contents.

Parameters

filePath :

string

The path of a .s2dscene or .s2dactor file to load.

listener :

scaleform.EventListener

The callback function

Returns

scaleform.Actor

The top level actor created (invalid until fully loaded)

The loaded actor may be accessed by connecting an event listener to the Loaded event type.

Parameters

self :

scaleform.Actor

The actor which is converted.

point :

scaleform.Point3

The 3D point of the actor which is converted.

Returns

scaleform.Point

The 2D point of the actor.

Parameters

self :

scaleform.Actor

The actor whose transform matrix is retrieved.

Returns

Matrix2F

The 2D transform matrix.

Parameters

self :

scaleform.Actor

The actor whose transform matrix is retrieved.

Returns

Matrix3F

The 3D transform matrix.

Parameters

self :

scaleform.Actor

The actor whose position is returned.

Returns

scaleform.Point

The position of the actor.

Parameters

self :

scaleform.Actor

The actor whose position is returned.

Returns

scaleform.Point

The position of the actor.

Parameters

self :

scaleform.Actor

The actor whose rotation is retrieved.

Returns

number

The rotation set for the actor.

Parameters

self :

scaleform.Actor

The actor whose rotation is retrieved.

Returns

scaleform.Point3

The three dimensional rotational value.

Parameters

self :

scaleform.Actor

The actor whose scale factor is returned.

Returns

scaleform.Point

The scale factor of the actor.

Parameters

self :

scaleform.Actor

The actor whose scale factor is returned.

Returns

scaleform.Point3

The scale factor of the actor.

Parameters

self :

scaleform.Actor

The actor which is converted.

point :

scaleform.Point

The point of the actor which is converted.

Returns

scaleform.Point

The converted point of the actor.

Parameters

self :

scaleform.Actor

The actor whose mask is retrieved.

Returns

scaleform.Actor

The masked actor.

Parameters

self :

scaleform.Actor

The actor which is the mask for another.

Returns

scaleform.Actor

The actor which has the mask.

Parameters

self :

scaleform.Actor

The actor which is mouse enabled.

Returns

boolean

Returns true if the actor is mouse enabled and false otherwise.

Parameters

self :

scaleform.Actor

The actor whose children are mouse enabled.

Returns

boolean

Returns true if the children are mouse enabled and false otherwise.

Parameters

self :

scaleform.Actor

The actor whose name is returned.

Returns

string

The name of the actor.

Parameters

self :

scaleform.Actor

The actor whose file path is retrieved.

separator :

string?

A separator for the path name. Default value of "."

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns

string

The file path.

A separator (dot by default) can be overridden (by using 'separator' parameter).

Parameters

self :

scaleform.Actor

The actor whose component is retrieved.

Returns

integer

The number of components of the actor.

Parameters

self :

scaleform.Actor

The actor whose parent, if any, is retrieved.

Returns

scaleform.Actor?

The parent of the actor.

The ? notation indicates that this type is optional: there may be zero or one instances of it.

Maybe NULL, if the object is not attached to any other object.

Parameters

self :

scaleform.Actor

The actor to perform the hit test on.

rect :

scaleform.Rect

A rectangle to test the object against.

checkShape :

boolean

Check the actor shape against the rect.

Returns

boolean

Returns true if the hit test passes, otherwise false.

Parameters

self :

scaleform.Actor

The actor to perform the hit test on.

point1 :

scaleform.Point

A point to test the object against.

point2 :

scaleform.Point

A point to test the object against.

point3 :

scaleform.Point

A point to test the object against.

point4 :

scaleform.Point

A point to test the object against.

checkShape :

boolean

Check the actor shape against the rect.

Returns

boolean

Returns true if the hit test passes, otherwise false.

Parameters

self :

scaleform.Actor

The actor to perform the hit test on.

point :

scaleform.Point

A point to test the object against.

checkShape :

boolean

Check the actor shape against the rect.

Returns

boolean

Returns true if the hit test passes, otherwise false.

Parameters

self :

scaleform.Actor

The actor whose projection matrix is retrieved.

inherit :

boolean

A boolean flag.

Returns

Matrix3F?

The projection matrix.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose property is retrieved.

propName :

string

The property name of the actor.

Returns

any?

The value of the property.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose bounds is retrieved.

matrix :

Matrix2F

The transformation matrix used for calculating the bounding rectangle.

Returns

scaleform.Rect?

A rectangle representing character bounds in the coordinate space.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose reference point is returned.

Returns

scaleform.Point

The reference point of the actor.

Parameters

self :

scaleform.Actor

The actor whose reference point is returned.

Returns

scaleform.Point3

The three dimensional reference point of the actor.

Parameters

self :

scaleform.Actor

The actor whose component is removed.

comp :

scaleform.Component

The component to remove.

Returns

boolean

Returns true if the component is removed and false otherwise.

Parameters

self :

scaleform.Actor

The actor to which a scale9grid is applied.

Returns

scaleform.Rect?

The scale9grid applied on the actor.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose scene is retrieved.

Returns

scaleform.Actor?

Returns a scene object.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose alpha transparency is set.

alpha :

number

A value set as the alpha for the actor [0-1.0].

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose blend descriptor is set.

blend :

table?

The blend descriptor set on the actor.

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.

Passing nil, will cause the object to inherit its blend mode.

Parameters

self :

scaleform.Actor

The actor whose blend mode is set.

blendmode :

scaleform.BlendModes

The blend mode (BlendMode) set on the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose bound is set.

bounds :

scaleform.Rect

The bounds - position and dimensions - set for the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to which a color transformation is applied.

cxform :

scaleform.Cxform

The color transform matrix value.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose dimension is set.

size :

scaleform.Size

The dimension to set for the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose anti-aliasing mode is set.

mode :

scaleform.EdgeAAModes

One of the anti-aliasing modes, scaleform.EdgeAAModes.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose filters is set.

filters :

scaleform.FilterSet?

The set of filters applied or nil to remove all filters.

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.Actor

The actor whose transform matrix is set.

matrix :

Matrix2F

The 2D transform matrix to be set.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose transform matrix is set.

matrix :

Matrix3F

The 3D transform matrix to be set.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose position is set.

point :

scaleform.Point

The position of the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose position is set.

point :

scaleform.Point3

The position of the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose rotation is set.

rotation :

number

The rotation set for the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose rotation is set.

angles :

scaleform.Point3

The angle with which to rotate (in degrees).

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose scale factor is set.

scale :

scaleform.Point

The amount to scale.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose scale factor is set.

scale :

scaleform.Point3

The amount to scale.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose mask is set.

mask :

scaleform.Actor?

The actor that is set as mask.

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.Actor

The actor which is mouse enabled.

enable :

boolean

A flag to enable mouse for the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose children are mouse enabled.

enable :

boolean

A flag to enable mouse for the children.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose name is set.

name :

string

The name for the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose projection matrix is set.

matrix :

Matrix3F

The projection matrix to set.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose property is set.

propValue :

table

A table of name property pairs to be set on the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose property is set.

propName :

string

The property name of the actor.

propValue :

any

The value of the property.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to set the ref point on.

refPoint :

scaleform.RefPoints

A special relative type of ref point.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to set the ref point on.

offset :

scaleform.Point

The offset position for the ref point.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to set the ref point on.

refPointType :

string

A special value for the ref points.

Returns
This function does not return any values.

Valid strings: "topleft", "topcenter", "topright", "centerleft", "center", "centerright", "bottomleft", "bottomcenter", "bottomright".

Parameters

self :

scaleform.Actor

The actor to set the ref point on.

x :

number

The coordinate value at x axis.

y :

number

The coordinate value at y axis.

z :

number

The coordinate value at z axis.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to set the ref point on.

refPointType :

string

A special value for the ref points.

z :

number

The coordinate value at z axis.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor to which a scale9grid is applied.

rect :

scaleform.Rect

A rectangle to which the Scale9grid is applied.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose tab order is set.

order :

integer

The order in the 'Tab' key sequence.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose view matrix is set.

matrix :

Matrix3F

The view matrix to set.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose visibility is set.

value :

boolean

A flag to set the visibility of the actor.

Returns
This function does not return any values.
Parameters

self :

scaleform.Actor

The actor whose tab order is returned

Returns

integer

The order in the 'Tab' key sequence.

Parameters

self :

scaleform.Actor

The actor whose view matrix is retrieved.

inherit :

boolean

A boolean flag.

Returns

Matrix3F?

The view matrix.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose visibility is set.

Returns

boolean

Returns true if the actor is visible and false otherwise.

Parameters

self :

scaleform.Actor

The actor whose bounds is retrieved.

matrix :

Matrix2F

The transformation matrix used for calculating the bounding rectangle.

Returns

scaleform.Rect?

The The visible bounds.

The ? notation indicates that this type is optional: there may be zero or one instances of it.

This function returns different result than bounds in the case when the actor (or any of its children) is masked and the mask reduces the visible area of the actor.

Parameters

self :

scaleform.Actor

The actor whose bounds is retrieved.

Returns

scaleform.Rect?

The transformed bounds of character.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.Actor

The actor whose color transform matrix is retrieved.

Returns

scaleform.Cxform

The concatenated color world matrix.

Maps from our local space into "world" space (i.e. root movie clip space).

Parameters

self :

scaleform.Actor

The actor whose world matrix is retrieved.

Returns

Matrix2F

The concatenated world matrix.

Maps from our local space into "world" space (i.e. root movie clip space).

Parameters

self :

scaleform.Actor

The actor whose world matrix is retrieved.

Returns

Matrix2F

The concatenated world matrix.

Maps from our local space into "world" space (i.e. root movie clip space).

Parameters

self :

scaleform.Actor

The actor whose global position is returned.

Returns

scaleform.Point

The global position of the actor.

Parameters

self :

scaleform.Actor

The actor whose global position is returned.

Returns

scaleform.Point

The global 3D position of the actor.

Parameters

self :

scaleform.Actor

The actor which is converted.

point :

scaleform.Point

The point of the Stage which is converted.

Returns

scaleform.Point

The converted point of the actor.

Parameters

self :

scaleform.Actor

The actor which is converted.

point :

scaleform.Point

The point of the Stage which is converted.

Returns

scaleform.Point3

The converted point of the actor.

 scaleform.EventDispatcher
The base object for managing event listeners and dispatching events to the listeners.  scaleform.Actor.actor_by_name_path (self, path) : scaleform.Actor?
Find an actor by a path.  scaleform.Actor.create (parent, components) : scaleform.Actor
Creates a new Actor, add to the parent, and creates any child components.  scaleform.Actor.load (filePath) : scaleform.Actor
Loads a saved prefab file and returns the newly actor tree.  scaleform.Actor.load_async (filePath, listener) : scaleform.Actor
Loads a saved prefab file asynchronously.  scaleform.Actor.mask_actor (self) : scaleform.Actor
Returns the actor that is set as the mask for the input actor.  scaleform.Actor.mask_owner (self) : scaleform.Actor
Returns the actor that is being masked by the supplied actor.  scaleform.Actor.parent (self) : scaleform.Actor?
Returns the parent of the object.  scaleform.Actor.scene (self) : scaleform.Actor?
Returns a scene object.  scaleform.Component.owner (self) : scaleform.Actor
Returns the Actor that has this component installed  scaleform.ContainerComponent.actors_in_quad (self, pt0, pt1, pt2, pt3, testShape) : scaleform.Actor[]
Gets the container's objects that are inside an area defined by four points.  scaleform.ContainerComponent.actors_in_rect (self, rect, testShape) : scaleform.Actor[]
Gets the container's objects that are inside a rect.  scaleform.ContainerComponent.actor_by_index (self, name) : scaleform.Actor?
Gets a child object by its name.  scaleform.ContainerComponent.actor_by_name (self, name) : scaleform.Actor?
Gets a child object by its name.  scaleform.ContainerComponent.remove_actor (self, actor, shutdownNextFrame) : scaleform.Actor?
Remove an object added to the container.  scaleform.ContainerComponent.remove_actor_by_index (self, index, shutdownNextFrame) : scaleform.Actor?
Remove an object added to the container.  scaleform.FMODSound.target (self) : scaleform.Actor
Returns the actor this sound object is linked to.  scaleform.Sound.target (self) : scaleform.Actor
Returns the actor this sound object is linked to.  scaleform.Stage.actor_by_name_path (name) : scaleform.Actor?
Find an actor by a path.  scaleform.Stage.add_scene (scene) : scaleform.Actor
Adds a new scene to the stage on top of any existing scenes.  scaleform.Stage.add_scene_by_index (scene, index) : scaleform.Actor
Adds a new scene at the specified index.  scaleform.Stage.find_focus (keyCodeStr, parentActor, loop, startFromActor, focusEnabledChars, controllerIdx) : scaleform.Actor?
Finds the next focus item.  scaleform.Stage.focus (controllerIdx) : scaleform.Actor
Returns currently focused object.  scaleform.Stage.modal_actor (controllerIdx) : scaleform.Actor?
Returns the actor set as modal actor set for focus management.  scaleform.Stage.move_focus (keyCodeStr, startFromActor, focusEnabledChars, controllerIdx) : scaleform.Actor
Moves a focus rectangle by simulating key pressing of one of focus keys: TAB, Shift-TAB or arrow keys.  scaleform.Stage.scene_by_index (index) : scaleform.Actor?
Gets the scene at the specified index.  scaleform.Stage.top_actor_at_point (point, controllerIdx, flags) : scaleform.Actor?
Returns a actor that is topmost at the specified point.  scaleform.BitmapComponent.create (owner) : scaleform.BitmapComponent
Creates a bitmap component for the actor.  scaleform.ContainerComponent.add_actor (self, actor, index) : integer
  scaleform.ContainerComponent.create (owner) : scaleform.ContainerComponent
Create a container component.  scaleform.ContainerComponent.index_of_actor (self, actor) : integer?
Gets the index of the object in a container.  scaleform.ContainerComponent.swap_actors (self, actor1, actor2) : boolean
Swaps the order of two objects in a container.  scaleform.PhysicsBodyComponent.create (owner) : scaleform.PhysicsBodyComponent
Create a physics body component.  scaleform.PhysicsWorldComponent.create (owner) : scaleform.PhysicsWorldComponent
Create a physics world component which drives the physics simulation.  scaleform.ScriptComponent.create (owner) : scaleform.ScriptComponent
Create a script component.  scaleform.ShapeComponent.create (owner) : scaleform.ShapeComponent
Creates a shape component for the actor.  scaleform.Sound.create (target) : scaleform.Sound
Creates a Sound object.  scaleform.SoundComponent.create (owner, sound_bank, event_name, lang) : scaleform.SoundComponent
Creates a new sound component.  scaleform.SpriteComponent.create (owner) : scaleform.SpriteComponent
Creates a new sprite component.  scaleform.Stage.focused (actor, controllerIdx) : boolean
Checks if the actor is focused by the specified controller or not.  scaleform.Stage.keyboard_focused (actor, controllerIdx) : boolean
Checks if the actor is focused for keyboard input.  scaleform.Stage.remove_scene (scene, shutdownNextFrame)
Removes the scene from the stage.  scaleform.Stage.set_focus (actor, controllerIdx, focusMovedType) : boolean
Transfers focus to specified item.  scaleform.Stage.set_modal_actor (actor, controllerIdx)
Sets the specified actor as a modal object for focus management.  scaleform.TextComponent.create (owner) : scaleform.TextComponent
Creates a new text component.  scaleform.Tweener.add_property (self, actor, id, propValue, finalValue)
Add a property for tween.  self : scaleform.Actor
The actor from which to start the relative path search.  path : string
The name path of the object to find.  scaleform.Actor?
The object at the given path, or nil if one is not found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor
Generic objects located in a scene. A string of characters.  scaleform.Actor.add_component (self, comp)
Adds a component to this actor.  self : scaleform.Actor
The actor to which a component is added.  comp : scaleform.Component
The component to add.  scaleform.Component
The root type of all actor components.  scaleform.Actor.alpha_scale (self) : number
Returns the alpha transparency of the actor.  self : scaleform.Actor
The actor whose alpha transparency is retrieved.  number
The alpha transparency value [0-1.0].A numeric value.  scaleform.Actor.ancestor (self, child) : boolean
Returns 'true' if object is an ancestor (parent, grand parent, grand grand parent, etc) of the specified actor.  self : scaleform.Actor
The actor whose ancestry is checked for.  child : scaleform.Actor
The actor whose ancestor is checked.  booleantrue or false.  scaleform.Actor.apply_rotation (self, angle)
Rotates by the specified angle relatively to current rotation.  self : scaleform.Actor
The actor to rotate.  angle : number
The angle with which to rotate (in degrees).  scaleform.Actor.apply_rotation_3d (self, xrot, yrot, zrot)
Performs a three dimensional rotation relative to the current rotation.  self : scaleform.Actor
The actor to rotate.  xrot : number
The angle with which to rotate along the X axis.  yrot : number
The angle with which to rotate along the Y axis.  zrot : number
The angle with which to rotate along the Z axis.  scaleform.Actor.apply_scale (self, scale)
Scales relatively to the current scale.  self : scaleform.Actor
The actor which is scaled.  scale : scaleform.Point
The scale factor for scaling relatively.  scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }  scaleform.Actor.apply_scale_3d (self, scale)
Performs a three dimensional scale transformation relative to the current scale.  self : scaleform.Actor
The actor which is scaled.  scale : scaleform.Point3
The scale factor for scaling relatively.  scaleform.Point3
Point3 should be in the form of a table {x=a, y=b, z=c}
{ PropertyType : string, x : number, y : number, z : number, }  scaleform.Actor.blend_descriptor (self) : table
Returns the blend descriptor of the actor.  self : scaleform.Actor
The actor whose blend descriptor is retrieved.  table
The blend descriptor of the actor.A Lua table consisting of paired keys and values.  scaleform.Actor.blend_mode (self) : scaleform.BlendModes
Returns the blend mode applied on the actor.  self : scaleform.Actor
The actor whose blend mode is retrieved.  scaleform.BlendModes
The blend mode (BlendMode) of the actor.  scaleform.BlendModes
The blend modes that can be applied to the actor.  scaleform.Actor.bounds (self, matrix) : scaleform.Rect?
Returns the character bounds in specified coordinate space.  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
A rectangle representing character bounds in the coordinate space.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  Matrix2F
A two-dimensional matrix in row-major order.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }  scaleform.Actor.visible_bounds (self, matrix) : scaleform.Rect?
Returns the visible bounds.  scaleform.Actor.component_by_index (self, index) : scaleform.Component
Returns the component of this actor at the given index.  self : scaleform.Actor
The actor whose component is retrieved.  index : integer
The index into the component list from 1 to number of components.  scaleform.Component
The specified component.A strictly integral numeric value, with no decimal component.  scaleform.Actor.component_by_name (self, name) : scaleform.Component
Returns the component with the given name.  self : scaleform.Actor
The actor whose component is retrieved.  name : string
The name of the component of this actor.  scaleform.Component
The specified component of the actor.  scaleform.Actor.concatenate_cxform (self, cxform)
Concatenates the color transform to the actor.  self : scaleform.Actor
The actor to which color transformation is concatenated.  cxform : scaleform.Cxform
The color transform matrix to concatenate.  scaleform.Cxform
A color transform class that modifies all pixels being rendered.  scaleform.Actor.concatenate_matrix (self, matrix)
Concatenates the passed matrix to the actor.  self : scaleform.Actor
The actor to which a matrix is concatenated.  matrix : Matrix2F
The matrix to concatenate.  scaleform.Actor.container (self) : scaleform.ContainerComponent
Returns the container component of this actor.  self : scaleform.Actor
The actor which is checked.  scaleform.ContainerComponent
The container component.  scaleform.ContainerComponent
An interface to container component.  parent : scaleform.ContainerComponent?
The parent container.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  components : any(table,table[])?
The children components to create- either a single Object table, or an array of Object tables.
The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor
The newly created Actor.  scaleform.Actor.cxform (self) : scaleform.Cxform
Returns the color transformation matrix applied on the actor.  self : scaleform.Actor
The actor whose color transformation is retrieved.  scaleform.Cxform
The color transformation matrix.  scaleform.Actor.dimensions (self) : scaleform.Size
Gets the dimensions of the actor.  self : scaleform.Actor
The actor whose dimension is retrieved.  scaleform.Size
The dimension set for the actor.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }  scaleform.Actor.edge_aa_mode (self) : scaleform.EdgeAAModes
Returns the edge anti-aliasing mode of the actor.  self : scaleform.Actor
The actor whose anti-aliasing mode is retrieved.  scaleform.EdgeAAModes
Returns the anti-aliasing mode set for the actor, scaleform.EdgeAAModes.  scaleform.EdgeAAModes
EdgeAAMode specified edge anti-aliasing state per object.  scaleform.Actor.filters (self) : scaleform.FilterSet
Returns the filters applied to the actor.  self : scaleform.Actor
The actor whose filters is set.  scaleform.FilterSet
Returns a set of the filters applied.  scaleform.FilterSet
Represents a set of filters.  scaleform.Actor.has_3d (self) : boolean
Indicates if the actor has a 3D transform applied to it.  self : scaleform.Actor
The actor checked to determine whether a 3D transform is applied.  boolean  scaleform.Actor.has_mask_actor (self) : boolean
Indicates if a mask is applied to the actor.  self : scaleform.Actor
The actor whose mask is set.  boolean  scaleform.Actor.has_scale9_grid (self) : boolean
Determines whether a Scale9Grid is applied to the actor.  self : scaleform.Actor
The actor which is checked.  boolean  scaleform.Actor.is_container (self) : boolean
Determines whether the actor is a container on the display list.  self : scaleform.Actor
The actor which is checked.  boolean  scaleform.Actor.is_mask_actor (self) : boolean
Check to see if an actor is set as a mask on another actor.  self : scaleform.Actor
The actor to check if it is a mask.  boolean  scaleform.Actor.is_scene (self) : boolean
Determines whether the actor is a scene object.  self : scaleform.Actor
The actor which is checked.  boolean  scaleform.Actor.is_shutdown (self) : boolean
Returns if the actor is shutdown, a shutdown actor has been removed from the scene and can not be reused.  self : scaleform.Actor
The actor to check if it has been shutdown.  boolean  scaleform.Actor.is_tabable (self) : boolean
Indicates if the actor is selectable by 'Tab' key or not.  self : scaleform.Actor
The actor whose tab index is returned  boolean  filePath : string
The path of a .s2dscene or .s2dactor file to load.  scaleform.Actor
The top level actor created from the file contents.  filePath : string
The path of a .s2dscene or .s2dactor file to load.  listener : scaleform.EventListener
The callback function  scaleform.Actor
The top level actor created (invalid until fully loaded)  scaleform.EventListener
The EventListener type.  scaleform.Actor.local_3d_to_world (self, point) : scaleform.Point
Converts a 3D point of the 3d actor's (local) coordinates to a 2D point in the Stage (global) coordinates.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point3
The 3D point of the actor which is converted.  scaleform.Point
The 2D point of the actor.  scaleform.Actor.local_matrix (self) : Matrix2F
Returns the 2D transform matrix on the actor.  self : scaleform.Actor
The actor whose transform matrix is retrieved.  Matrix2F
The 2D transform matrix.  scaleform.Actor.local_matrix_3d (self) : Matrix3F
Returns the 3D transform matrix on the actor.  self : scaleform.Actor
The actor whose transform matrix is retrieved.  Matrix3F
The 3D transform matrix.  Matrix3F
A three-dimensional matrix in row-major order.  scaleform.Actor.local_position (self) : scaleform.Point
Returns the position of the actor.  self : scaleform.Actor
The actor whose position is returned.  scaleform.Point
The position of the actor.  scaleform.Actor.local_position_3d (self) : scaleform.Point
Returns the 3D position of the actor.  self : scaleform.Actor
The actor whose position is returned.  scaleform.Point
The position of the actor.  scaleform.Actor.local_rotation (self) : number
Returns normalized rotation, in degrees, [0..360].  self : scaleform.Actor
The actor whose rotation is retrieved.  number
The rotation set for the actor.  scaleform.Actor.local_rotation_3d (self) : scaleform.Point3
Returns the three dimensional rotation of the actor.  self : scaleform.Actor
The actor whose rotation is retrieved.  scaleform.Point3
The three dimensional rotational value.  scaleform.Actor.local_scale (self) : scaleform.Point
Returns the scaling factor of the actor.  self : scaleform.Actor
The actor whose scale factor is returned.  scaleform.Point
The scale factor of the actor.  scaleform.Actor.local_scale_3d (self) : scaleform.Point3
Returns the three dimensional scaling factor of the actor.  self : scaleform.Actor
The actor whose scale factor is returned.  scaleform.Point3
The scale factor of the actor.  scaleform.Actor.local_to_world (self, point) : scaleform.Point
Converts a point of the actor's (local) coordinates to a point in the Stage (global) coordinates.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point
The point of the actor which is converted.  scaleform.Point
The converted point of the actor.  self : scaleform.Actor
The actor whose mask is retrieved.  scaleform.Actor
The masked actor.  self : scaleform.Actor
The actor which is the mask for another.  scaleform.Actor
The actor which has the mask.  scaleform.Actor.mouse_enabled (self) : boolean
Determines whether or not the actor is mouse enabled.  self : scaleform.Actor
The actor which is mouse enabled.  boolean  scaleform.Actor.mouse_enabled_for_children (self) : boolean
Determines whether or not children of the actor is mouse enabled.  self : scaleform.Actor
The actor whose children are mouse enabled.  boolean  scaleform.Actor.name (self) : string
Returns the name of the actor.  self : scaleform.Actor
The actor whose name is returned.  string
The name of the actor.  scaleform.Actor.name_path (self, separator) : string
Assembles a 'path' to the object, in the following format: parent1Name.parent0Name.childName.  self : scaleform.Actor
The actor whose file path is retrieved.  separator : string?
A separator for the path name. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  string
The file path.  scaleform.Actor.num_components (self) : integer
Returns the number of components in this actor.  self : scaleform.Actor
The actor whose component is retrieved.  integer
The number of components of the actor.  self : scaleform.Actor
The actor whose parent, if any, is retrieved.  scaleform.Actor?
The parent of the actor.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.perform_hit_test (self, rect, checkShape) : boolean
Test if rect intersects or contains the actor.  self : scaleform.Actor
The actor to perform the hit test on.  rect : scaleform.Rect
A rectangle to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  scaleform.Actor.perform_hit_test (self, point1, point2, point3, point4, checkShape) : boolean
Test if a quad intersects or contains the actor.  self : scaleform.Actor
The actor to perform the hit test on.  point1 : scaleform.Point
A point to test the object against.  point2 : scaleform.Point
A point to test the object against.  point3 : scaleform.Point
A point to test the object against.  point4 : scaleform.Point
A point to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  scaleform.Actor.perform_hit_test (self, point, checkShape) : boolean
Test if point intersects or contains the actor.  self : scaleform.Actor
The actor to perform the hit test on.  point : scaleform.Point
A point to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  scaleform.Actor.projection_matrix_3d (self, inherit) : Matrix3F?
Returns the projection matrix set on the actor for drawing 3D movie clips.  self : scaleform.Actor
The actor whose projection matrix is retrieved.  inherit : boolean
A boolean flag.  Matrix3F?
The projection matrix.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.property (self, propName) : any?
Gets the property value of the actor.  self : scaleform.Actor
The actor whose property is retrieved.  propName : string
The property name of the actor.  any?
The value of the property.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
This value may be an instance of any type.  scaleform.Actor.rect_bounds (self, matrix) : scaleform.Rect?
Returns character bounds excluding stroke.  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
A rectangle representing character bounds in the coordinate space.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.ref_point (self) : scaleform.Point
Returns the reference point of the actor.  self : scaleform.Actor
The actor whose reference point is returned.  scaleform.Point
The reference point of the actor.  scaleform.Actor.ref_point_3d (self) : scaleform.Point3
Returns the three dimensional reference point of the actor.  self : scaleform.Actor
The actor whose reference point is returned.  scaleform.Point3
The three dimensional reference point of the actor.  scaleform.Actor.remove_component (self, comp) : boolean
Removes a component from this actor.  self : scaleform.Actor
The actor whose component is removed.  comp : scaleform.Component
The component to remove.  boolean  scaleform.Actor.scale9_grid (self) : scaleform.Rect?
Returns the scale9grid set on the actor.  self : scaleform.Actor
The actor to which a scale9grid is applied.  scaleform.Rect?
The scale9grid applied on the actor.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.Actor
The actor whose scene is retrieved.  scaleform.Actor?
Returns a scene object.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.set_alpha_scale (self, alpha)
Sets the alpha transparency of the actor.  self : scaleform.Actor
The actor whose alpha transparency is set.  alpha : number
A value set as the alpha for the actor [0-1.0].  scaleform.Actor.set_blend_descriptor (self, blend)
Sets the blend descriptor on the actor.  self : scaleform.Actor
The actor whose blend descriptor is set.  blend : table?
The blend descriptor set on the actor.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.set_blend_mode (self, blendmode)
Sets the blend mode on the actor.  self : scaleform.Actor
The actor whose blend mode is set.  blendmode : scaleform.BlendModes
The blend mode (BlendMode) set on the actor.  scaleform.Actor.set_bounds (self, bounds)
Sets the bounds of the actor.  self : scaleform.Actor
The actor whose bound is set.  bounds : scaleform.Rect
The bounds - position and dimensions - set for the actor.  scaleform.Actor.set_cxform (self, cxform)
Sets the color transformation matrix on the actor.  self : scaleform.Actor
The actor to which a color transformation is applied.  cxform : scaleform.Cxform
The color transform matrix value.  scaleform.Actor.set_dimensions (self, size)
Sets the dimensions of the actor.  self : scaleform.Actor
The actor whose dimension is set.  size : scaleform.Size
The dimension to set for the actor.  scaleform.Actor.set_edge_aa_mode (self, mode)
Sets the edge anti-aliasing mode of the actor.  self : scaleform.Actor
The actor whose anti-aliasing mode is set.  mode : scaleform.EdgeAAModes
One of the anti-aliasing modes, scaleform.EdgeAAModes.  scaleform.Actor.set_filters (self, filters)
Applies a set of filters to the actor.  self : scaleform.Actor
The actor whose filters is set.  filters : scaleform.FilterSet?
The set of filters applied or nil to remove all filters.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.set_local_matrix (self, matrix)
Sets a 2D transform matrix on the actor.  self : scaleform.Actor
The actor whose transform matrix is set.  matrix : Matrix2F
The 2D transform matrix to be set.  scaleform.Actor.set_local_matrix_3d (self, matrix)
Sets a 3D transform matrix on the actor.  self : scaleform.Actor
The actor whose transform matrix is set.  matrix : Matrix3F
The 3D transform matrix to be set.  scaleform.Actor.set_local_position (self, point)
Sets the position of the actor.  self : scaleform.Actor
The actor whose position is set.  point : scaleform.Point
The position of the actor.  scaleform.Actor.set_local_position_3d (self, point)
Sets the 3D position for the actor.  self : scaleform.Actor
The actor whose position is set.  point : scaleform.Point3
The position of the actor.  scaleform.Actor.set_local_rotation (self, rotation)
Sets the 2D (Z) rotation, in degrees [-360..0..360].  self : scaleform.Actor
The actor whose rotation is set.  rotation : number
The rotation set for the actor.  scaleform.Actor.set_local_rotation_3d (self, angles)
Sets the 3D rotation of the actor.  self : scaleform.Actor
The actor whose rotation is set.  angles : scaleform.Point3
The angle with which to rotate (in degrees).  scaleform.Actor.set_local_scale (self, scale)
Sets the scaling factor of the actor.  self : scaleform.Actor
The actor whose scale factor is set.  scale : scaleform.Point
The amount to scale.  scaleform.Actor.set_local_scale_3d (self, scale)
Sets the 3D scaling factor of the actor.  self : scaleform.Actor
The actor whose scale factor is set.  scale : scaleform.Point3
The amount to scale.  scaleform.Actor.set_mask_actor (self, mask)
Sets the actor as the masked actor, null will remove the mask.  self : scaleform.Actor
The actor whose mask is set.  mask : scaleform.Actor?
The actor that is set as mask.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.set_mouse_enabled (self, enable)
Sets the flag to set the actor as mouse enabled.  self : scaleform.Actor
The actor which is mouse enabled.  enable : boolean
A flag to enable mouse for the actor.  scaleform.Actor.set_mouse_enabled_for_children (self, enable)
Sets the flag to set the children of the actor as mouse enabled.  self : scaleform.Actor
The actor whose children are mouse enabled.  enable : boolean
A flag to enable mouse for the children.  scaleform.Actor.set_name (self, name)
Sets the name of the actor.  self : scaleform.Actor
The actor whose name is set.  name : string
The name for the actor.  scaleform.Actor.set_projection_matrix_3d (self, matrix)
Sets a projection matrix on the actor for drawing 3D movie clips.  self : scaleform.Actor
The actor whose projection matrix is set.  matrix : Matrix3F
The projection matrix to set.  scaleform.Actor.set_properties (self, propValue)
Sets the property values of the actor.  self : scaleform.Actor
The actor whose property is set.  propValue : table
A table of name property pairs to be set on the actor.  scaleform.Actor.set_property (self, propName, propValue)
Sets the property value of the actor.  self : scaleform.Actor
The actor whose property is set.  propName : string
The property name of the actor.  propValue : any
The value of the property.  scaleform.Actor.set_ref_point (self, refPoint)
Sets a reference point for the actor.  self : scaleform.Actor
The actor to set the ref point on.  refPoint : scaleform.RefPoints
A special relative type of ref point.  scaleform.RefPoints
The relative reference points that can be specified on the actor.  scaleform.Actor.set_ref_point (self, offset)
Sets a reference point for the actor.  self : scaleform.Actor
The actor to set the ref point on.  offset : scaleform.Point
The offset position for the ref point.  scaleform.Actor.set_ref_point (self, refPointType)
Sets a reference point for the actor.  self : scaleform.Actor
The actor to set the ref point on.  refPointType : string
A special value for the ref points.  scaleform.Actor.set_ref_point_3d (self, x, y, z)
Sets a three dimensional reference point for the actor.  self : scaleform.Actor
The actor to set the ref point on.  x : number
The coordinate value at x axis.  y : number
The coordinate value at y axis.  z : number
The coordinate value at z axis.  scaleform.Actor.set_ref_point_3d (self, refPointType, z)
Sets a three dimensional reference point for the actor.  self : scaleform.Actor
The actor to set the ref point on.  refPointType : string
A special value for the ref points.  z : number
The coordinate value at z axis.  scaleform.Actor.set_scale9_grid (self, rect)
Sets a scale9grid on the actor.  self : scaleform.Actor
The actor to which a scale9grid is applied.  rect : scaleform.Rect
A rectangle to which the Scale9grid is applied.  scaleform.Actor.set_tab_order (self, order)
Sets an order in 'Tab' key sequence.  self : scaleform.Actor
The actor whose tab order is set.  order : integer
The order in the 'Tab' key sequence.  scaleform.Actor.set_view_matrix_3d (self, matrix)
Sets a view matrix on the actor for drawing 3D movie clips.  self : scaleform.Actor
The actor whose view matrix is set.  matrix : Matrix3F
The view matrix to set.  scaleform.Actor.set_visible (self, value)
Sets the visibility of the actor.  self : scaleform.Actor
The actor whose visibility is set.  value : boolean
A flag to set the visibility of the actor.  scaleform.Actor.tab_order (self) : integer
Returns the order in 'Tab' key sequence.  self : scaleform.Actor
The actor whose tab order is returned  integer
The order in the 'Tab' key sequence.  scaleform.Actor.view_matrix_3d (self, inherit) : Matrix3F?
Returns the view matrix set on the actor for drawing 3D movie clips.  self : scaleform.Actor
The actor whose view matrix is retrieved.  inherit : boolean
A boolean flag.  Matrix3F?
The view matrix.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.visible (self) : boolean
Indicates whether the actor is visible or not.  self : scaleform.Actor
The actor whose visibility is set.  boolean  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
The The visible bounds.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.world_bounds (self) : scaleform.Rect?
Returns the transformed bounds of character in root movie space.  self : scaleform.Actor
The actor whose bounds is retrieved.  scaleform.Rect?
The transformed bounds of character.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor.world_cxform (self) : scaleform.Cxform
Returns the concatenated color transform matrix (all ancestor transforms, times the matrix).  self : scaleform.Actor
The actor whose color transform matrix is retrieved.  scaleform.Cxform
The concatenated color world matrix.  scaleform.Actor.world_matrix (self) : Matrix2F
Returns the concatenated matrix (all ancestor transforms, times the matrix).  self : scaleform.Actor
The actor whose world matrix is retrieved.  Matrix2F
The concatenated world matrix.  scaleform.Actor.world_matrix_3d (self) : Matrix2F
Returns the concatenated world matrix (complete 2D + 3D world matrix).  self : scaleform.Actor
The actor whose world matrix is retrieved.  Matrix2F
The concatenated world matrix.  scaleform.Actor.world_position (self) : scaleform.Point
Returns the global position (on Stage) of the actor.  self : scaleform.Actor
The actor whose global position is returned.  scaleform.Point
The global position of the actor.  scaleform.Actor.world_position_3d (self) : scaleform.Point
Returns the global 3D position (on Stage) of the actor.  self : scaleform.Actor
The actor whose global position is returned.  scaleform.Point
The global 3D position of the actor.  scaleform.Actor.world_to_local (self, point) : scaleform.Point
Converts a point in the Stage (global) coordinates to an actor's (local) coordinates.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point
The point of the Stage which is converted.  scaleform.Point
The converted point of the actor.  scaleform.Actor.world_to_local_3d (self, point) : scaleform.Point3
Converts a point in the Stage (global) coordinates to a 3D actor's (local) coordinates.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point
The point of the Stage which is converted.  scaleform.Point3
The converted point of the actor.  self : scaleform.Component
The component to get the owner of.  scaleform.Actor
The owner of the actor or nil if there is not one.  self : scaleform.ContainerComponent
The container that contains the objects to test are in a a quad.  pt0 : scaleform.Point
The quad's first point.  pt1 : scaleform.Point
The quad's second point.  pt2 : scaleform.Point
The quad's third point.  pt3 : scaleform.Point
The quad's fourth point.  testShape : boolean?
The control whether to test the object's shape against the quad.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor[]
Returns a list of objects in the quad.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.ContainerComponent
The container that contains the objects to test are in a a rect.  rect : scaleform.Rect
The rect to test.  testShape : boolean?
The control whether to test the object's shape against the rect.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor[]
Returns a list of objects in the rect.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.ContainerComponent
The container to get the object from.  name : string
The name of the object to find.  scaleform.Actor?
Returns the objects with the same name or nil if one is not found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ContainerComponent
The container to get the object from.  name : string
The name of the object to find.  scaleform.Actor?
Returns the objects with the same name or nil if one is not found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ContainerComponent
The container to remove the object from.  actor : scaleform.Actor
The actor to remove.  shutdownNextFrame : boolean?
The actor will be shutdown the following frame if not added back into the scene, default is true.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
Returns the actor removed or nil if it was not removed.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ContainerComponent
The container to remove the object from.  index : integer
The index of the object to remove.  shutdownNextFrame : boolean?
The actor will be shutdown the following frame if not added back into the scene, default is true.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
Returns the actor removed or nil if it was not removed.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.Sound
The sound object currently considered.  scaleform.Actor
The actor linked with this Sound object.  self : scaleform.Sound
The sound object currently considered.  scaleform.Actor
The actor linked with this Sound object.  name : string
The name path of the object to find.  scaleform.Actor?
The object at the given path, or nil if one is not found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scene : scaleform.Actor
The actor to be used as the scene.  scaleform.Actor
Returns the actor just added.  scene : scaleform.Actor
The new scene that is to be added to the existing scene.  index : integer
The index at which the scene is added.  scaleform.Actor
Returns the actor just added.  keyCodeStr : scaleform.Keys
A key to simulate.  parentActor : scaleform.Actor?
The actor container that is used as a modal focus. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  loop : boolean?
Boolean flag to loop focus. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  startFromActor : scaleform.Actor?
Use this actor as the starting point instead of currently focused one. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  focusEnabledChars : boolean?
A flag that allows to move focus onto only focus-enabled, tab-enabled/tab-indexed actors. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  controllerIdx : integer?
Index of the controller used for the operation. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
Returns next actor to be focused or nil if the actor cannot be found.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  controllerIdx : integer?
The index of the physical controller.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor
The focused object.  controllerIdx : integer
The index of the controller.  scaleform.Actor?
The modal actor if one is set or nil if none are set.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  keyCodeStr : scaleform.Keys
A key to simulate.  startFromActor : scaleform.Actor?
Use this as the starting point instead of currently focused one. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  focusEnabledChars : boolean?
A flag that allows to move focus onto only focus-enabled, tab-enabled/tab-indexed actors. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  controllerIdx : integer?
Index of the controller used for the operation. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor
Returns next actor to be focused or NULL if the actor cannot be found.  index : integer
The index at which the scene is retrieved.  scaleform.Actor?
The scene actor at the index or nil if there is not one.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  point : scaleform.Point
The point at which the actor is returned.  controllerIdx : integer?
Index of the controller used.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  flags : integer?
Bit flags.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
The actor that is topmost or nil if there isn't one.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  owner : scaleform.Actor
The actor parent of the newly created layout.  scaleform.BitmapComponent
A handle to the newly create bitmap component.  self : scaleform.ContainerComponent
The container to add the object to.  actor : scaleform.Actor
The actor to add to the container.  index : integer?
Index to insert the object at.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  integer  owner : scaleform.Actor
The parent object of the newly created container component.  scaleform.ContainerComponent
Returns the newly created ContainerComponent.  self : scaleform.ContainerComponent
The container to get the object's index in.  actor : scaleform.Actor
The actor to get the index of.  integer?
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ContainerComponent
The container which contains the objects to swap.  actor1 : scaleform.Actor
The first object to swap with the second.  actor2 : scaleform.Actor
The second object to swap with the first.  boolean  owner : scaleform.Actor
The parent object of the newly created physics body component.  scaleform.PhysicsBodyComponent
Returns the newly created PhysicsBodyComponent.  owner : scaleform.Actor
The parent object of the newly created physics World.  scaleform.PhysicsWorldComponent
Returns the newly created PhysicsWorldComponent.  owner : scaleform.Actor
The parent object of the newly created container component.  scaleform.ScriptComponent
Returns the newly created ScriptComponent.  owner : scaleform.Actor
The actor parent of the newly created shape.  scaleform.ShapeComponent
A handle to the newly create shape component.  target : scaleform.Actor
The actor to link the sound.  scaleform.Sound
The newly created Sound object.  owner : scaleform.Actor
The owner actor of the component.  sound_bank : string?
Sound bank name.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  event_name : string?
Sound event name.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  lang : string?
Current language.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.SoundComponent
The newly created SoundComponent.  owner : scaleform.Actor
The owner actor of the component.  scaleform.SpriteComponent
Returns the newly created SpriteComponent.  actor : scaleform.Actor
The actor.  controllerIdx : integer?
The index of the physical controller.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  actor : scaleform.Actor
The actor that is passed.  controllerIdx : integer?
The index of the physical controller.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  scene : scaleform.Actor
The scene that is to removed from the existing scene.  shutdownNextFrame : boolean?
The scene will be shutdown the following frame if not added back into the stage, default is true.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  actor : scaleform.Actor
The actor to whom the focus is set.  controllerIdx : integer?
The index of the physical controller.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  focusMovedType : string?
Flag to indicate how focus was transferred -either by mouse, keyboard or manually.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  actor : scaleform.Actor
The actor specified as modal clip.  controllerIdx : integer?
The index of the controller.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  owner : scaleform.Actor
The owner actor of the component.  scaleform.TextComponent
The newly created text component.  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.Sound
A Sound object for playing audio through Wwise Wwise is only available if Scaleform Studio is compiled with it enabled (by default it is enabled).  scaleform.Keys
The possible keyboard keys.  scaleform.BitmapComponent
An interface to bitmap component.  scaleform.PhysicsBodyComponent
Describes a Actor's physical properties.  scaleform.PhysicsWorldComponent
Drives the Physics simulation of all child objects that have physical properties  scaleform.ScriptComponent
An interface to script component.  scaleform.ShapeComponent
An interface to shape component.  scaleform.SoundComponent
An interface to sound component for Wwise audio.  scaleform.SpriteComponent
Represents a sprite object.  scaleform.TextComponent
Represent the text field.  scaleform.Tweener
A Lua interface to Tweener. 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.
Please send us your comment about this page