Scaleform Studio Lua API Reference: scaleform.ScriptComponent object reference
scaleform.ScriptComponent object reference
Description
An interface to script component.
Inheritance 
Constructors and accessors
Related help topics
Functions
Parameters
Returns
owner : |
The parent object of the newly created container component. |
|
Returns the newly created ScriptComponent. |
Parameters
Returns
self : |
The script component to execute. | |
scriptText : | string |
The script that is to be executed. |
scriptSize : | integer |
The size of the string representing a script. |
boolean |
Returns true if the script runs successfully and false otherwise. |
Parameters
Returns
self : |
The script component to execute. | |
filename : | string |
The file containing the script. |
boolean |
Returns true if the script runs and false otherwise. |
Parameters
Returns
self : |
The script component to execute. |
any* |
The values returned from the script components script. The * notation indicates that there may be zero or more instances of the specified type. |
This data may be null, a single value, or multiple values.
scaleform.ComponentThe root type of all actor components.
scaleform.ScriptComponent.create (owner) : scaleform.ScriptComponentCreate a script component.
owner : scaleform.ActorThe parent object of the newly created container component.
scaleform.ScriptComponentReturns the newly created ScriptComponent.
scaleform.ActorGeneric objects located in a scene.
scaleform.ScriptComponentAn interface to script component.
scaleform.ScriptComponent.run_script (self, scriptText, scriptSize) : booleanExecutes the script.
self : scaleform.ScriptComponentThe script component to execute.
scriptText : stringThe script that is to be executed.
scriptSize : integerThe size of the string representing a script.
booleanA string of characters.A strictly integral numeric value, with no decimal component.true or false. scaleform.ScriptComponent.run_script_file (self, filename) : booleanExecutes the script file.
self : scaleform.ScriptComponentThe script component to execute.
filename : stringThe file containing the script.
boolean scaleform.ScriptComponent.script_results (self) : any*Returns the data set on the actor for storing script specific data.
self : scaleform.ScriptComponentThe script component to execute.
any*The values returned from the script components script.
The * notation indicates that there may be zero or more instances of the specified type.
This value may be an instance of any type.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.