Scaleform Studio Lua API Reference: scaleform.CustomEvent table reference

scaleform.CustomEvent table reference

Description

The event parameters for Custom event.

The table passed as the data parameter can only contain specific types. For additional details please refer to the Events section in the Programming Guide.

Data Members

Note that there are restrictions on supported data types.

name : string
The name of the event.
 scaleform.Event

{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }
 scaleform.EventTypes.Custom
The custom event, scaleform.CustomEvent.
 scaleform.CustomEvent.data : table
Data payload for the event.
A Lua table consisting of paired keys and values.  scaleform.CustomEvent.name : string
The name of the event.
A string of characters.  scaleform.Actor
Generic objects located in a scene.
 scaleform.EventTypes
The list of events.
 scaleform.CustomEvent
The event parameters for Custom event.
{ data : table, name : string, }
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.