Scaleform Studio Lua API Reference: Objects
Objects
This page contains an alphabetical list of all objects in the API.
Matrix2FA two-dimensional matrix in row-major order.
Matrix3FA three-dimensional matrix in row-major order.
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.physics.BodyInterface for physics properties of a vgx actor.
scaleform.physics.ChainShapeRepresents a chain shape consisting of multiple line segments.
scaleform.physics.CircleShapeRepresents a circle that extends the shape and adds a radius and a local position.
scaleform.physics.DistanceJointA distant joint that keeps two bodies at the same distance.
scaleform.physics.EdgeShapeRepresents an edge shape consisting of a line segment.
scaleform.physics.FixtureAn interface to attach shapes to the fixtures.
scaleform.physics.FrictionJointA friction joint that applies friction to a body.
scaleform.physics.GearJointA gear joint that keeps bodies together in such a way that they act like gears.
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.MouseJointA mouse joint for controlling objects with the mouse.
scaleform.physics.PolygonShapeRepresents a polygon shape with up to 8 sides.
scaleform.physics.PrismaticJointA Prismatic joint that allows two bodies to revolve around a shared point.
scaleform.physics.PulleyJointA pulley joint that allows you to simulate bodies connected through pulleys.
scaleform.physics.RevoluteJointA revolute joint that allows two bodies to revolve around a shared point.
scaleform.physics.RopeJointA rope joint that keeps bodies together in such a way that they act like ropes
scaleform.physics.ShapeRepresents shape used in fixtures.
scaleform.physics.WeldJointA weld joint that essentially glues two bodies together.
scaleform.physics.WheelJointA wheel joint that allows two bodies to revolve around a shared point.
scaleform.physics.WorldManages all physics entities, dynamic simulation, and asynchronous queries.
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. 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.