Scaleform Studio Lua API Reference: scaleform.Component object reference
scaleform.Component object reference
Description
The root type of all actor components.
Inheritance 
Constructors and accessors
Other related reference items
Related help topics
Functions
Parameters
Returns
self : |
The component to get the name of. |
string |
The name of the component. |
Parameters
Returns
self : |
The component to get the owner of. |
|
The owner of the actor or nil if there is not one. |
Parameters
Returns
self : |
The component whose property is retrieved. | |
propName : | string |
The property name of the component. |
any |
The value of the property that may be a string, number, handle, or table depending on the property type. |
Parameters
Returns
self : |
The component to set the name of. | |
name : | string |
The name to use. |
| This function does not return any values. |
Parameters
Returns
self : |
The component whose property is set. | |
propValue : | table |
A table of string value pairs for all properties |
boolean |
Returns true if all of the properties were set. |
Parameters
Returns
self : |
The component whose property is set. | |
propName : | string |
The property name of the component. |
propValue : | any |
The value of the property. |
boolean |
Returns true if the property was set. |
scaleform.CameraComponentAn interface to camera component.
scaleform.PhysicsBodyComponentDescribes a Actor's physical properties.
scaleform.PhysicsWorldComponentDrives the Physics simulation of all child objects that have physical properties
scaleform.ScriptComponentAn interface to script component.
scaleform.SoundComponentAn interface to sound component for Wwise audio.
scaleform.VisualComponentAn interface to the visual component.
scaleform.BitmapComponentAn interface to bitmap component.
scaleform.ContainerComponentAn interface to container component.
scaleform.AnimationComponentControls a timeline animation
scaleform.ShapeComponentAn interface to shape component.
scaleform.SpriteComponentRepresents a sprite object.
scaleform.TextComponentRepresent the text field.
scaleform.Actor.component_by_index (self, index) : scaleform.ComponentReturns the component of this actor at the given index.
scaleform.Actor.component_by_name (self, name) : scaleform.ComponentReturns the component with the given name.
scaleform.Actor.add_component (self, comp) Adds a component to this actor.
scaleform.Actor.remove_component (self, comp) : booleanRemoves a component from this actor.
scaleform.Component.name (self) : stringGets the name of the component.
self : scaleform.ComponentThe component to get the name of.
stringThe name of the component.
scaleform.ComponentThe root type of all actor components. A string of characters.
scaleform.Component.owner (self) : scaleform.ActorReturns the Actor that has this component installed
self : scaleform.ComponentThe component to get the owner of.
scaleform.ActorThe owner of the actor or nil if there is not one.
scaleform.ActorGeneric objects located in a scene.
scaleform.Component.property (self, propName) : anyGets the property value of the component.
self : scaleform.ComponentThe component whose property is retrieved.
propName : stringThe property name of the component.
anyThe value of the property that may be a string, number, handle, or table depending on the property type.This value may be an instance of any type.
scaleform.Component.set_name (self, name) Sets the name of the component.
self : scaleform.ComponentThe component to set the name of.
name : stringThe name to use.
scaleform.Component.set_properties (self, propValue) : booleanSets the property values of the component.
self : scaleform.ComponentThe component whose property is set.
propValue : tableA table of string value pairs for all properties
booleanA Lua table consisting of paired keys and values.true or false. scaleform.Component.set_property (self, propName, propValue) : booleanSets the property value of the component.
self : scaleform.ComponentThe component whose property is set.
propName : stringThe property name of the component.
propValue : anyThe value of the property.
boolean scaleform.Component.type (self) : stringReturns the type of the component.
self : scaleform.ComponentThe component to get the type of.
stringThe type of the component.
self : scaleform.ActorThe actor whose component is retrieved.
index : integerThe index into the component list from 1 to number of components.
scaleform.ComponentThe specified component.
self : scaleform.ActorThe actor whose component is retrieved.
name : stringThe name of the component of this actor.
scaleform.ComponentThe specified component of the actor.
self : scaleform.ActorThe actor to which a component is added.
comp : scaleform.ComponentThe component to add.
self : scaleform.ActorThe actor whose component is removed.
comp : scaleform.ComponentThe component to remove.
booleanA strictly integral numeric value, with no decimal component.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.