Scaleform Studio Lua API Reference
Welcome to the Scaleform Studio Lua API Reference!
This set of pages contains a detailed companion to all the objects, functions and other elements in the Scaleform Studio Lua API. You can use any of these API elements in your own UI scripts.
A good place to begin browsing the API is to take a look at the list of all objects, or start exploring the elements exposed in the global namespace.
Note that if you are using Scaleform Studio within a Stingray game, Stingray and Scaleform Studio share the same Lua environment in your runtime game. Therefore, in addition to the API elements described in this reference, you can also use the objects and functions in the Stingray Lua API.
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.