Scaleform Studio Lua API Reference: scaleform.LuaHandle object reference
scaleform.LuaHandle object reference
Description
The native system object handle type.
Handles manage memory ownership between the lua environment which is garbage collected and the underlying native engine which use smart pointers. A handle ensures that the underlying C++ object will not be destroyed unless are references in both the engine and in the script environment are lost.
When a project unload all handles created to objects in that project are invalidated.
Functions
scaleform.LuaHandle.is_valid (handle) : booleanChecks to see if a handle is valid.
handle : scaleform.LuaHandleThe handle to check if valid.
boolean
scaleform.LuaHandleThe native system object handle type. true or false.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.