Scaleform Studio Lua API Reference: scaleform namespace reference
scaleform namespace reference
Description
The core classes used in the Scaleform Studio.
Related help topics 
Namespaces
Objects
Enumerations
Functions
Parameters
Returns
| This function does not accept any parameters. |
userdata |
The module. |
Parameters
Returns
| This function does not accept any parameters. |
integer |
The current time in milliseconds |
This value will wrap every ~49 days.
Parameters
Returns
init : |
An table arguments to initialize the returned scaleform.Path table with. // Only defined members of scaleform.Path are copied from the input type. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Path table. |
Parameters
Returns
init : |
A partial table of values used to initialize the Point. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Point table. |
Parameters
Returns
init : |
An table arguments to initialize the returned scaleform.Point3 table with. // Only defined members of scaleform.Point3 are copied from the input type. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Point3 table. |
Parameters
Returns
init : |
A partial table of values used to initialize the Point3. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Point3 table. |
Parameters
Returns
args : | any* |
The text/values to be displayed. The * notation indicates that there may be zero or more instances of the specified type. |
| This function does not return any values. |
Parameters
Returns
init : |
An table arguments to initialize the returned scaleform.Rect table with. // Only defined members of scaleform.Rect are copied from the input type. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed rectangle table. |
Parameters
Returns
init : |
A partial table of values used to initialize the Rect. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Rect table. |
Parameters
Returns
init : |
An table arguments to initialize the returned scaleform.Size table with. // Only defined members of scaleform.Size are copied from the input type. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed size table. |
Parameters
Returns
init : |
A partial table of values used to initialize the Size. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Size table. |
Parameters
Returns
init : |
An table arguments to initialize the returned scaleform.Viewport table with. // Only defined members of scaleform.Viewport are copied from the input type. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
Returns a fully constructed Viewport table. |
Other related reference items
scaleform.buildNamespace which contains functions for getting information about Scaleform Studio.
scaleform.EventListenerThe EventListener type.
scaleform.physicsThe Scaleform Studio physics interface.
scaleform.AccelerometerDispatches events based on activity detected by the device's motion sensor.
scaleform.ActorGeneric objects located in a scene.
scaleform.AnimationComponentControls a timeline animation
scaleform.BevelFilterRepresents a bevel filter.
scaleform.BitmapComponentAn interface to bitmap component.
scaleform.BlurFilterA general implementation for a blur family of filters, which include Glow and Shadow functionality.
scaleform.CameraComponentAn interface to camera component.
scaleform.ColorMatrixFilterRepresents a color matrix filter.
scaleform.ComponentThe root type of all actor components.
scaleform.ContainerComponentAn interface to container component.
scaleform.CxformA color transform class that modifies all pixels being rendered.
scaleform.EasingRepresents an easing functor.
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.Filter scaleform.FilterSetRepresents a set of filters.
scaleform.FMODSoundA Sound object for audio.
scaleform.GeolocationDispatches events in response to the device's location sensor.
scaleform.GlowFilterRepresents a glow filter.
scaleform.LuaEventListenerInternal C++ Event Listener binding object.
scaleform.LuaHandleThe native system object handle type.
scaleform.ParagraphFormatUsed for formatting of paragraphs.
scaleform.PhysicsBodyComponentDescribes a Actor's physical properties.
scaleform.PhysicsWorldComponentDrives the Physics simulation of all child objects that have physical properties
scaleform.ScriptComponentAn interface to script component.
scaleform.ShadowFilterRepresents a shadow filter.
scaleform.ShapeComponentAn interface to shape component.
scaleform.SoundA Sound object for playing audio through Wwise Wwise is only available if Scaleform Studio is compiled with it enabled (by default it is enabled).
scaleform.SoundComponentAn interface to sound component for Wwise audio.
scaleform.SpriteComponentRepresents a sprite object.
scaleform.StageRepresents a stage.
scaleform.TextComponentRepresent the text field.
scaleform.TextFormatUsed for formatting of text.
scaleform.TimerRepresents a timer.
scaleform.TimerBaseAn interface to timer objects.
scaleform.TweenerA Lua interface to Tweener.
scaleform.VisualComponentAn interface to the visual component.
scaleform.AlignModesThe alignment types for paragraph formatting.
scaleform.AnalogControlsThe possible analog or touchpad controls which generate 2 axis input.
scaleform.BlendModesThe blend modes that can be applied to the actor.
scaleform.ButtonsThe possible game pad buttons that generate press events.
scaleform.EasingTypesThe type of easing performed.
scaleform.EdgeAAModesEdgeAAMode specified edge anti-aliasing state per object.
scaleform.EventTypesThe list of events.
scaleform.KeysThe possible keyboard keys.
scaleform.PropertyTypesAn internal enumeration assigned to the constant PropertyType on tables which are supported for properties on Actors and Components.
scaleform.RefPointsThe relative reference points that can be specified on the actor.
scaleform.TextAAModesThe different anti-aliasing modes can be set for a text component.
scaleform.TextFilterTypesThe different filters that can be applied to text.
scaleform.TimerTypesThe types of timers.
scaleform.TweenerModesAn internal enumeration that controls behavior of tweeners.
scaleform.VAlignModesThe vertical alignment modes that can be set for a text component.
scaleform.ViewAlignModesThe view alignment mode of the stage.
scaleform.ViewScaleModesThe view scale mode of the stage.
scaleform.get_module () : userdataReturns the desired module.
userdataThe module.A raw memory buffer that is allocated and maintained in the Lua environment.
scaleform.get_time () : integerReturns The current time in milliseconds from the start of the player/runtime.
integerA strictly integral numeric value, with no decimal component. scaleform.Path (init) : scaleform.PathCreate an initialized path table.
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[]?, }
scaleform.Point (init) : scaleform.PointCreate an initialized point table.
init : scaleform.Point?A partial table of values used to initialize the Point.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.PointReturns a fully constructed Point table.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.Point3 (init) : scaleform.Point3Create an initialized Point3 table.
init : scaleform.Point3?An table arguments to initialize the returned scaleform.Point3 table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.Point3Returns a fully constructed Point3 table.
scaleform.Point3Point3 should be in the form of a table {x=a, y=b, z=c}
{ PropertyType : string, x : number, y : number, z : number, }
init : scaleform.Point3?A partial table of values used to initialize the Point3.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.Point3Returns a fully constructed Point3 table.
scaleform.print (args) Prints the text/result of an operation on the screen.
args : any*The text/values to be displayed.
The * notation indicates that there may be zero or more instances of the specified type.
This value may be an instance of any type. scaleform.Rect (init) : scaleform.RectCreate an initialized rectangle table.
init : scaleform.Rect?An table arguments to initialize the returned scaleform.Rect table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.RectReturns a fully constructed rectangle table.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
init : scaleform.Rect?A partial table of values used to initialize the Rect.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.RectReturns a fully constructed Rect table.
scaleform.Size (init) : scaleform.SizeCreate an initialized size table.
init : scaleform.Size?An table arguments to initialize the returned scaleform.Size table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.SizeReturns a fully constructed size table.
scaleform.SizeWidth should be in the form of a table {width=a, height=b}
{ height : number, width : number, }
init : scaleform.Size?A partial table of values used to initialize the Size.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.SizeReturns a fully constructed Size table.
scaleform.Viewport (init) : scaleform.ViewportCreate an initialized viewport table.
init : scaleform.Viewport?An table arguments to initialize the returned scaleform.Viewport table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ViewportReturns a fully constructed Viewport table.
scaleform.Stage.set_viewport (viewport) Sets the render-target surface viewport to which the stage is scaled; coordinates are specified in pixels. A string of characters.A Lua table consisting of paired keys and values.A numeric value.
viewport : scaleform.ViewportA pointer to Viewport, containing the viewport information.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.