Scaleform Studio Lua API Reference: scaleform.Path table reference
scaleform.Path table reference
Description
Represents a complex ShapePath.
Constructors and accessors 
Other related reference items
Data Members
 |
The property type of the path, scaleform.PropertyTypes.
|
The segments member is also an array of path command tables . A path command table is an array of values which starts with a string path command and its numeric arguments. Path commands are 'MoveTo', 'LineTo' and 'QuadTo'. MoveTo and LineTo are followed by two numeric values which are the x and y coordinates. QuadTo is followed by four numeric values which represents the quad to draw.
scaleform.Path (init) : scaleform.PathCreate an initialized path table.
scaleform.Path.filename : string?The filename. A string of characters.
scaleform.Path.propertyType : stringThe property type of the path, scaleform.PropertyTypes.
scaleform.PropertyTypesAn internal enumeration assigned to the constant PropertyType on tables which are supported for properties on Actors and Components.
scaleform.Path.segments : table[]?An array of tables, where each table has a single member called 'Segments'. A Lua table consisting of paired keys and values.
init : scaleform.Path?An table arguments to initialize the returned scaleform.Path table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.PathReturns a fully constructed Path table.
scaleform.PathRepresents a complex ShapePath.
{ filename : string?, propertyType : string, segments : table[]?, }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.