Scaleform Studio Lua API Reference: scaleform.Point3 table reference
Point3 should be in the form of a table {x=a, y=b, z=c}
scaleform.Actor.local_rotation_3d (self) : scaleform.Point3
Returns the three dimensional rotation of the actor.
scaleform.Actor.local_scale_3d (self) : scaleform.Point3
Returns the three dimensional scaling factor of the actor.
scaleform.Actor.ref_point_3d (self) : scaleform.Point3
Returns the three dimensional reference point of the actor.
scaleform.Actor.world_to_local_3d (self, point) : scaleform.Point3
Converts a point in the Stage (global) coordinates to a 3D actor's (local) coordinates.
scaleform.CameraComponent.position (self) : scaleform.Point3
Gets the position of the camera.
scaleform.Point3 (init) : scaleform.Point3
Create an initialized Point3 table.
scaleform.Actor.apply_scale_3d (self, scale)
Performs a three dimensional scale transformation relative to the current scale.
scaleform.Actor.local_3d_to_world (self, point) : scaleform.Point
Converts a 3D point of the 3d actor's (local) coordinates to a 2D point in the Stage (global) coordinates.
scaleform.Actor.set_local_position_3d (self, point)
Sets the 3D position for the actor.
scaleform.Actor.set_local_rotation_3d (self, angles)
Sets the 3D rotation of the actor.
scaleform.Actor.set_local_scale_3d (self, scale)
Sets the 3D scaling factor of the actor.
scaleform.CameraComponent.look_at (self, pt)
Move the camera to the desired position.
scaleform.CameraComponent.set_position (self, pt)
Sets the position of the camera.
scaleform.Point3.PropertyType : string
The property type of the path, scaleform.PropertyTypes.
A string of characters.
scaleform.PropertyTypes
An internal enumeration assigned to the constant PropertyType on tables which are supported for properties on Actors and Components.
scaleform.Point3.x : number
X coordinate.
A numeric value.
scaleform.Point3.y : number
Y coordinate.
scaleform.Point3.z : number
Z coordinate.
self : scaleform.Actor
The actor whose rotation is retrieved.
scaleform.Point3
The three dimensional rotational value.
self : scaleform.Actor
The actor whose scale factor is returned.
scaleform.Point3
The scale factor of the actor.
self : scaleform.Actor
The actor whose reference point is returned.
scaleform.Point3
The three dimensional reference point of the actor.
self : scaleform.Actor
The actor which is converted.
point : scaleform.Point
The point of the Stage which is converted.
scaleform.Point3
The converted point of the actor.
self : scaleform.CameraComponent
The camera component whose position is set.
scaleform.Point3
The position of the camera component.
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.Point3
Returns a fully constructed Point3 table.
self : scaleform.Actor
The actor which is scaled.
scale : scaleform.Point3
The scale factor for scaling relatively.
self : scaleform.Actor
The actor which is converted.
point : scaleform.Point3
The 3D point of the actor which is converted.
scaleform.Point
The 2D point of the actor.
self : scaleform.Actor
The actor whose position is set.
point : scaleform.Point3
The position of the actor.
self : scaleform.Actor
The actor whose rotation is set.
angles : scaleform.Point3
The angle with which to rotate (in degrees).
self : scaleform.Actor
The actor whose scale factor is set.
scale : scaleform.Point3
The amount to scale.
self : scaleform.CameraComponent
The camera component currently in use.
pt : scaleform.Point3
The desired position.
self : scaleform.CameraComponent
The camera component whose position is set.
pt : scaleform.Point3
The desired position coordinate of the camera component.
scaleform.Actor
Generic objects located in a scene.
scaleform.Point3
Point3 should be in the form of a table {x=a, y=b, z=c}
{ PropertyType : string, x : number, y : number, z : number, }
scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.CameraComponent
An interface to camera 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.