Scaleform Studio Lua API Reference: scaleform.ContainerComponent object reference
scaleform.ContainerComponent object reference
Description
An interface to container component.
Inheritance 
Constructors and accessors
Other related reference items
Related help topics
Functions
Parameters
Returns
self : |
The container that contains the objects to test are in a a quad. | |
pt0 : |
The quad's first point. | |
pt1 : |
The quad's second point. | |
pt2 : |
The quad's third point. | |
pt3 : |
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. |
|
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. |
Parameters
Returns
self : |
The container that contains the objects to test are in a a rect. | |
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. |
|
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. |
Parameters
Returns
self : |
The container to get the object from. | |
name : | string |
The name of the object to find. |
|
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. |
Parameters
Returns
self : |
The container to get the object from. | |
name : | string |
The name of the object to find. |
|
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. |
Parameters
Returns
self : |
The container to add the object to. | |
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 |
The index that the object was added at. |
Parameters
Returns
owner : |
The parent object of the newly created container component. |
|
Returns the newly created ContainerComponent. |
Parameters
Returns
self : |
The container to get the object's index in. | |
actor : |
The actor to get the index of. |
integer? |
Returns the index of the object or nil if the object is not in the container. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The container to get the number of child objects. |
integer |
Returns the number of child objects contained by the container. |
Parameters
Returns
self : |
The container to remove the object from. | |
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. |
|
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. |
Parameters
Returns
self : |
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. |
|
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. |
Parameters
Returns
self : |
The container to remove all objects from. | |
markForShutdown : | 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. |
| This function does not return any values. |
Parameters
Returns
self : |
The container which contains the objects to swap. | |
actor1 : |
The first object to swap with the second. | |
actor2 : |
The second object to swap with the first. |
boolean |
Returns true if the objects were swapped successfully or else false. |
Parameters
Returns
self : |
The container which contains the objects to swap. | |
index1 : | integer |
The index of the first object to swap with the second. |
index2 : | integer |
The index of the second object to swap with the first. |
boolean |
Returns true if the objects were swapped successfully or else false. |
scaleform.ComponentThe root type of all actor components.
scaleform.VisualComponentAn interface to the visual component.
scaleform.AnimationComponentControls a timeline animation
scaleform.Actor.container (self) : scaleform.ContainerComponentReturns the container component of this actor.
scaleform.ContainerComponent.create (owner) : scaleform.ContainerComponentCreate a container component.
scaleform.Actor.create (parent, components) : scaleform.ActorCreates a new Actor, add to the parent, and creates any child components.
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.
self : scaleform.ContainerComponentThe container that contains the objects to test are in a a quad.
pt0 : scaleform.PointThe quad's first point.
pt1 : scaleform.PointThe quad's second point.
pt2 : scaleform.PointThe quad's third point.
pt3 : scaleform.PointThe 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.
scaleform.ContainerComponentAn interface to container component.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }true or false.
scaleform.ActorGeneric objects located in a scene.
scaleform.ContainerComponent.actors_in_rect (self, rect, testShape) : scaleform.Actor[]Gets the container's objects that are inside a rect.
self : scaleform.ContainerComponentThe container that contains the objects to test are in a a rect.
rect : scaleform.RectThe 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.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
scaleform.ContainerComponent.actor_by_index (self, name) : scaleform.Actor?Gets a child object by its name.
self : scaleform.ContainerComponentThe container to get the object from.
name : stringThe 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.
A string of characters. scaleform.ContainerComponent.actor_by_name (self, name) : scaleform.Actor?Gets a child object by its name.
self : scaleform.ContainerComponentThe container to get the object from.
name : stringThe 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.
scaleform.ContainerComponent.add_actor (self, actor, index) : integer self : scaleform.ContainerComponentThe container to add the object to.
actor : scaleform.ActorThe 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.
integerA strictly integral numeric value, with no decimal component. owner : scaleform.ActorThe parent object of the newly created container component.
scaleform.ContainerComponentReturns the newly created ContainerComponent.
scaleform.ContainerComponent.index_of_actor (self, actor) : integer?Gets the index of the object in a container.
self : scaleform.ContainerComponentThe container to get the object's index in.
actor : scaleform.ActorThe actor to get the index of.
integer?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ContainerComponent.num_actors (self) : integerGets the number of objects in the container.
self : scaleform.ContainerComponentThe container to get the number of child objects.
integer scaleform.ContainerComponent.remove_actor (self, actor, shutdownNextFrame) : scaleform.Actor?Remove an object added to the container.
self : scaleform.ContainerComponentThe container to remove the object from.
actor : scaleform.ActorThe 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.
scaleform.ContainerComponent.remove_actor_by_index (self, index, shutdownNextFrame) : scaleform.Actor?Remove an object added to the container.
self : scaleform.ContainerComponentThe container to remove the object from.
index : integerThe 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.
scaleform.ContainerComponent.remove_all (self, markForShutdown) Remove all objects added to the container.
self : scaleform.ContainerComponentThe container to remove all objects from.
markForShutdown : 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.ContainerComponent.swap_actors (self, actor1, actor2) : booleanSwaps the order of two objects in a container.
self : scaleform.ContainerComponentThe container which contains the objects to swap.
actor1 : scaleform.ActorThe first object to swap with the second.
actor2 : scaleform.ActorThe second object to swap with the first.
boolean scaleform.ContainerComponent.swap_actor_by_index (self, index1, index2) : booleanSwaps the order of two objects in a container.
self : scaleform.ContainerComponentThe container which contains the objects to swap.
index1 : integerThe index of the first object to swap with the second.
index2 : integerThe index of the second object to swap with the first.
boolean self : scaleform.ActorThe actor which is checked.
scaleform.ContainerComponentThe 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.ActorThe newly created Actor.A numeric value.A Lua table consisting of paired keys and values.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.