Scaleform Studio Lua API Reference: scaleform.Point table reference

scaleform.Point table reference
Data Members
expand all | collapse all

Description

Point should be in the form of a table {x=a, y=b}

Data Members

PropertyType : string
The property type of the path, scaleform.PropertyTypes.
x : number
X coordinate.
y : number
Y coordinate.
 Matrix2F.Transform (self, pt) : scaleform.Point
Transforms the point by the matrix.  Matrix2F.TransformByInverse (self, pt) : scaleform.Point
Transforms the point by the inverse of the matrix.  Matrix2F.TransformVector (self, pt) : scaleform.Point
Transforms the vector by the matrix.  Matrix2F.TransformVectorByInverse (self, pt) : scaleform.Point
Transforms the vector by the inverse of the matrix.  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.local_position (self) : scaleform.Point
Returns the position of the actor.  scaleform.Actor.local_position_3d (self) : scaleform.Point
Returns the 3D position of the actor.  scaleform.Actor.local_scale (self) : scaleform.Point
Returns the scaling factor of the actor.  scaleform.Actor.local_to_world (self, point) : scaleform.Point
Converts a point of the actor's (local) coordinates to a point in the Stage (global) coordinates.  scaleform.Actor.ref_point (self) : scaleform.Point
Returns the reference point of the actor.  scaleform.Actor.world_position (self) : scaleform.Point
Returns the global position (on Stage) of the actor.  scaleform.Actor.world_position_3d (self) : scaleform.Point
Returns the global 3D position (on Stage) of the actor.  scaleform.Actor.world_to_local (self, point) : scaleform.Point
Converts a point in the Stage (global) coordinates to an actor's (local) coordinates.  scaleform.BlurFilter.shadow_offset (self) : scaleform.Point
Returns the offset of the blur filter.  scaleform.physics.Body.linear_velocity (self) : scaleform.Point
Returns the linear velocity of the body.  scaleform.physics.Body.linear_velocity_from_local_point (self, local) : scaleform.Point
Gets the linear velocity of local point attached to this body.  scaleform.physics.Body.linear_velocity_from_world_point (self, world) : scaleform.Point
Gets the linear velocity of world point attached to this body.  scaleform.physics.Body.local_center (self) : scaleform.Point
Returns the local position of the body's center of mass.  scaleform.physics.Body.local_to_world_point (self, local) : scaleform.Point
Gets the world coordinates of a point given the local coordinates.  scaleform.physics.Body.local_to_world_vector (self, local) : scaleform.Point
Gets the world coordinates of a vector given the local coordinates.  scaleform.physics.Body.position (self) : scaleform.Point
Returns the position of the body.  scaleform.physics.Body.world_center (self) : scaleform.Point
Returns the world position of the body's center of mass.  scaleform.physics.Body.world_to_local_point (self, world) : scaleform.Point
Gets a local point relative to the body's origin given a world point.  scaleform.physics.Body.world_to_local_vector (self, world) : scaleform.Point
Gets a local vector given a world vector.  scaleform.physics.ChainShape.next_vertex (self) : scaleform.Point
Returns a vertex that establishes a connection to the next shape.  scaleform.physics.ChainShape.prev_vertex (self) : scaleform.Point
Returns a vertex that establishes a connection to the previous shape.  scaleform.physics.ChainShape.vertex_by_index (self, index) : scaleform.Point
Returns the vertex of the shape at the specified index.  scaleform.physics.CircleShape.position (self) : scaleform.Point
Returns the position of the circle shape.  scaleform.physics.CircleShape.support_vertex (self, dir) : scaleform.Point
Gets the supporting vertex in the given direction.  scaleform.physics.CircleShape.vertex_by_index (self, index) : scaleform.Point
Returns the vertex of the shape at the specified index.  scaleform.physics.DistanceJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.DistanceJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.EdgeShape.vertex_0 (self) : scaleform.Point
Gets the coordinate of the first edge point.  scaleform.physics.EdgeShape.vertex_1 (self) : scaleform.Point
Gets the coordinate of the second edge point.  scaleform.physics.EdgeShape.vertex_2 (self) : scaleform.Point
Gets the coordinate of the third edge point.  scaleform.physics.EdgeShape.vertex_3 (self) : scaleform.Point
Gets the coordinate of the fourth edge point.  scaleform.physics.FrictionJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.FrictionJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.Joint.anchor_a (self) : scaleform.Point
Gets the anchor point of the first body of the bodies that are currently linked through this joint.  scaleform.physics.Joint.anchor_b (self) : scaleform.Point
Gets the anchor point of the second body of the bodies that are currently linked through this joint.  scaleform.physics.MouseJoint.target (self) : scaleform.Point
Gets the target point.  scaleform.physics.PolygonShape.centroid (self) : scaleform.Point
Returns the centroid of the polygon shape.  scaleform.physics.PolygonShape.vertex_by_index (self, index) : scaleform.Point
Returns the vertex of the shape at the specified index.  scaleform.physics.PrismaticJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.PrismaticJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.PrismaticJoint.local_axis_a (self) : scaleform.Point
Returns the local joint axis relative to body A.  scaleform.physics.PulleyJoint.ground_anchor_a (self) : scaleform.Point
Gets the ground anchor point for body A.  scaleform.physics.PulleyJoint.ground_anchor_b (self) : scaleform.Point
Gets the ground anchor point for body B.  scaleform.physics.RevoluteJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.RevoluteJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.RopeJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.RopeJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.WeldJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.WeldJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.WheelJoint.local_anchor_a (self) : scaleform.Point
Returns the local anchor point relative to body A.  scaleform.physics.WheelJoint.local_anchor_b (self) : scaleform.Point
Returns the local anchor point relative to body B.  scaleform.physics.WheelJoint.local_axis_a (self) : scaleform.Point
Returns the local joint axis relative to body A.  scaleform.physics.World.gravity (self) : scaleform.Point
Returns the gravity of the world.  scaleform.Point (init) : scaleform.Point
Create an initialized point table.  scaleform.Stage.translate_point_to_screen (p, userMatrix) : scaleform.Point
Translates a point in Stage coordinates to screen (window) coordinates.  Matrix2F.AppendRelative (self, m, pt) : Matrix2F
Performs the Append transform operation relative to a specified origin/pivot point.  scaleform.Actor.apply_scale (self, scale)
Scales relatively to the current scale.  scaleform.Actor.perform_hit_test (self, point1, point2, point3, point4, checkShape) : boolean
Test if a quad intersects or contains the actor.  scaleform.Actor.perform_hit_test (self, point, checkShape) : boolean
Test if point intersects or contains the actor.  scaleform.Actor.set_local_position (self, point)
Sets the position of the actor.  scaleform.Actor.set_local_scale (self, scale)
Sets the scaling factor of the actor.  scaleform.Actor.set_ref_point (self, offset)
Sets a reference point for 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.set_zoom_anchor (self, pt)
Sets the zoom anchor point to move the camera to the position of the anchor point.  scaleform.ContainerComponent.actors_in_quad (self, pt0, pt1, pt2, pt3, testShape) : scaleform.Actor[]
Gets the container's objects that are inside an area defined by four points.  scaleform.physics.Body.apply_force (self, force, point)
Applies a force to the object at a given world point.  scaleform.physics.Body.apply_force_to_center (self, center)
Applies a force to the body's center of mass.  scaleform.physics.Body.apply_linear_impulse (self, impulse, point)
Applies an impulse at a point.  scaleform.physics.Body.apply_linear_impulse_to_center (self, impulse)
Applies an impulse to the body's center of mass.  scaleform.physics.Body.set_linear_velocity (self, velocity)
Sets the linear velocity of the body.  scaleform.physics.Body.set_transform (self, pos, angle)
Sets the body's position and rotation.This breaks any contacts and wakes the other bodies.  scaleform.physics.ChainShape.create_chain (self, points)
Creates a chain shape.  scaleform.physics.ChainShape.create_loop (self, points)
Creates a chain loop where the first and last vertices are connected.  scaleform.physics.ChainShape.set_next_vertex (self, point)
Sets a vertex that establishes a connection to the next shape.  scaleform.physics.ChainShape.set_prev_vertex (self, point)
Sets a vertex that establishes a connection to the previous shape.  scaleform.physics.ChainShape.set_vertex_by_index (self, index, point)
Sets a new vertex for the shape at the specified index.  scaleform.physics.CircleShape.set_position (self, position)
Sets the position of the circle shape.  scaleform.physics.CircleShape.support_vertex_index (self, dir) : integer
Gets the supporting vertex index in the given direction.  scaleform.physics.EdgeShape.set_vertices (self, v1, v2)
Sets the coordinate points of the edge shape.  scaleform.physics.Fixture.test_point (self, pt) : boolean
Test a point for containment in this fixture.  scaleform.physics.MouseJoint.set_target (self, target)
Sets the target point.  scaleform.physics.PolygonShape.set_as_box (self, hw, hh, center, angle)
Sets the parameters to turn a polygon into a box shape.  scaleform.physics.PolygonShape.set_centroid (self, point)
Sets the centroid of the polygon shape.  scaleform.physics.PolygonShape.set_vertex_by_index (self, index, point)
Sets a new vertex for the shape at the specified index.  scaleform.physics.PolygonShape.set_vertices (self, points)
Creates a polygon shape by setting vertices.  scaleform.physics.Shape.compute_aabb (self, position, rotation, chainShapeChildIndex) : scaleform.Rect
Given a transform, compute the associated axis aligned bounding box for a child shape.  scaleform.physics.Shape.test_point (self, position, rotation, point) : boolean
Test a point for containment in this shape.  scaleform.physics.World.start (self, gravity, scale)
Initializes the physics world.  scaleform.ShapeComponent.begin_path (self, point) : boolean
Begins a path.  scaleform.ShapeComponent.draw_circle (self, center, radius) : boolean
Draws a circle using current line and fill styles.  scaleform.ShapeComponent.draw_curve_to (self, control, anchor) : boolean
Draws a quadratic Bezier curve using the current line style from the current drawing position to (anchorX, anchorY) and using the control point that (controlX, controlY) specifies.  scaleform.ShapeComponent.draw_ellipse (self, center, size) : boolean
Draws a ellipse using current line and fill styles.  scaleform.ShapeComponent.draw_line_to (self, point) : boolean
Draws a line using the current line style from the current drawing position to (x, y).  scaleform.ShapeComponent.move_to (self, point) : boolean
Moves the current drawing position to (x, y).  scaleform.Stage.top_actor_at_point (point, controllerIdx, flags) : scaleform.Actor?
Returns a actor that is topmost at the specified point.  scaleform.Point.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.Point.x : number
X coordinate. A numeric value.  scaleform.Point.y : number
Y coordinate.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
The point which is to be transformed.  scaleform.Point
A point containing the result of the transformation.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
The point to be transformed.  scaleform.Point
A point containing the result of the transformation.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
Vector to transform.  scaleform.Point
A point containing the result of the transformation.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
Vector to transform.  scaleform.Point
A point containing the result of the transformation.  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 returned.  scaleform.Point
The position of the actor.  self : scaleform.Actor
The actor whose position is returned.  scaleform.Point
The position of the actor.  self : scaleform.Actor
The actor whose scale factor is returned.  scaleform.Point
The scale factor of the actor.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point
The point of the actor which is converted.  scaleform.Point
The converted point of the actor.  self : scaleform.Actor
The actor whose reference point is returned.  scaleform.Point
The reference point of the actor.  self : scaleform.Actor
The actor whose global position is returned.  scaleform.Point
The global position of the actor.  self : scaleform.Actor
The actor whose global position is returned.  scaleform.Point
The global 3D position of the actor.  self : scaleform.Actor
The actor which is converted.  point : scaleform.Point
The point of the Stage which is converted.  scaleform.Point
The converted point of the actor.  self : scaleform.BlurFilter
The filter currently in use.  scaleform.Point
The offset of the filter.  self : scaleform.physics.Body
The physics body currently in use.  scaleform.Point
The linear velocity.  self : scaleform.physics.Body
The physics body currently in use.  local : scaleform.Point
The local point coordinates.  scaleform.Point
Linear velocity of local point.  self : scaleform.physics.Body
The physics body currently in use.  world : scaleform.Point
The world point coordinates.  scaleform.Point
Linear velocity of world point.  self : scaleform.physics.Body
The physics body currently in use.  scaleform.Point
The local position.  self : scaleform.physics.Body
The physics body currently in use.  local : scaleform.Point
The local point coordinates.  scaleform.Point
The world coordinates.  self : scaleform.physics.Body
The physics body currently in use.  local : scaleform.Point
The coordinates of local vector.  scaleform.Point
The world coordinates.  self : scaleform.physics.Body
The physics body currently in use.  scaleform.Point
The position of the body.  self : scaleform.physics.Body
The physics body currently in use.  scaleform.Point
The world position.  self : scaleform.physics.Body
The physics body currently in use.  world : scaleform.Point
The world point coordinates.  scaleform.Point
The local point.  self : scaleform.physics.Body
The physics body currently in use.  world : scaleform.Point
The coordinates of world vector.  scaleform.Point
A local vector.  self : scaleform.physics.ChainShape
The chain shape currently in use.  scaleform.Point
The vertex of the next shape.  self : scaleform.physics.ChainShape
The chain shape currently in use.  scaleform.Point
The vertex of the previous shape.  self : scaleform.physics.ChainShape
The chain shape currently in use.  index : integer
The index at which the vertex is returned.  scaleform.Point
The vertex.  self : scaleform.physics.CircleShape
The circle shape currently in use.  scaleform.Point
The position of the circle shape.  self : scaleform.physics.CircleShape
The circle shape currently used.  dir : scaleform.Point
The specified direction.  scaleform.Point
The supporting vertex of the shape.  self : scaleform.physics.CircleShape
The circle shape currently in use.  index : integer
The index at which the vertex is returned.  scaleform.Point
The shape vertex.  self : scaleform.physics.DistanceJoint
Current distance joint connecting two bodies.  scaleform.Point
The local anchor point.  self : scaleform.physics.DistanceJoint
Current distance joint connecting two bodies.  scaleform.Point
The local anchor point.  self : scaleform.physics.EdgeShape
The edge shape currently in use.  scaleform.Point
The coordinate of the first edge point.  self : scaleform.physics.EdgeShape
The edge shape currently in use.  scaleform.Point
The coordinate of the second edge point.  self : scaleform.physics.EdgeShape
The edge shape currently in use.  scaleform.Point
The coordinate of the third edge point.  self : scaleform.physics.EdgeShape
The edge shape currently in use.  scaleform.Point
The coordinate of the fourth edge point.  self : scaleform.physics.FrictionJoint
Friction joint currently in use.  scaleform.Point
The local anchor point.  self : scaleform.physics.FrictionJoint
Friction joint currently in use.  scaleform.Point
The local anchor point.  self : scaleform.physics.Joint
The joint currently in use.  scaleform.Point
The anchor point of the first body.  self : scaleform.physics.Joint
The joint currently in use.  scaleform.Point
The anchor point of the second body.  self : scaleform.physics.MouseJoint
The mouse joint currently considered.  scaleform.Point
The target point.  self : scaleform.physics.PolygonShape
The polygon shape in use.  scaleform.Point
The point set as centroid.  self : scaleform.physics.PolygonShape
The polygon shape in use.  index : integer
The index at which the vertex is returned.  scaleform.Point
The vertex at the specified index.  self : scaleform.physics.PrismaticJoint
The prismatic joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.PrismaticJoint
The prismatic joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.PrismaticJoint
The prismatic joint currently in use.  scaleform.Point
The axis point.  self : scaleform.physics.PulleyJoint
The pulley joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.PulleyJoint
The pulley joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.RevoluteJoint
The revolute joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.RevoluteJoint
The revolute joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.RopeJoint
The rope joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.RopeJoint
The rope joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.WeldJoint
The weld joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.WeldJoint
The weld joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.WheelJoint
The wheel joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.WheelJoint
The wheel joint currently in use.  scaleform.Point
The anchor point.  self : scaleform.physics.WheelJoint
The wheel joint currently in use.  scaleform.Point
The axis point.  self : scaleform.physics.World
The physics World that is currently in use.  scaleform.Point
Gravity value.  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.Point
Returns a fully constructed Point table.  p : scaleform.Point
The point in stage coordinates  userMatrix : Matrix2F
The renderer matrix  scaleform.Point
The point in screen coordinates  self : Matrix2F
The 2D matrix currently in use.  m : Matrix2F
The matrix to which append operation is performed.  pt : scaleform.Point?
The pivot point.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  Matrix2F
The transformed matrix.  self : scaleform.Actor
The actor which is scaled.  scale : scaleform.Point
The scale factor for scaling relatively.  self : scaleform.Actor
The actor to perform the hit test on.  point1 : scaleform.Point
A point to test the object against.  point2 : scaleform.Point
A point to test the object against.  point3 : scaleform.Point
A point to test the object against.  point4 : scaleform.Point
A point to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  self : scaleform.Actor
The actor to perform the hit test on.  point : scaleform.Point
A point to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  self : scaleform.Actor
The actor whose position is set.  point : scaleform.Point
The position of the actor.  self : scaleform.Actor
The actor whose scale factor is set.  scale : scaleform.Point
The amount to scale.  self : scaleform.Actor
The actor to set the ref point on.  offset : scaleform.Point
The offset position for the ref point.  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 currently in use.  pt : scaleform.Point
The zoom anchor point.  self : scaleform.ContainerComponent
The container that contains the objects to test are in a a quad.  pt0 : scaleform.Point
The quad's first point.  pt1 : scaleform.Point
The quad's second point.  pt2 : scaleform.Point
The quad's third point.  pt3 : scaleform.Point
The quad's fourth point.  testShape : boolean?
The control whether to test the object's shape against the quad.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor[]
Returns a list of objects in the quad.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.physics.Body
The physics body currently in use.  force : scaleform.Point
The force applied to the object.  point : scaleform.Point
The world point at which the force is applied.  self : scaleform.physics.Body
The physics body currently in use.  center : scaleform.Point
The force applied to the body's center.  self : scaleform.physics.Body
The physics body currently in use.  impulse : scaleform.Point
The impulse applied to the point.  point : scaleform.Point
The point at which the impulse is applied.  self : scaleform.physics.Body
The physics body currently in use.  impulse : scaleform.Point
The impulse to be applied.  self : scaleform.physics.Body
The physics body currently in use.  velocity : scaleform.Point
The linear velocity of the body  self : scaleform.physics.Body
The physics body currently in use.  pos : scaleform.Point
The position of the body in Physics World coordinates.  angle : number
The rotation of the body in radians.  self : scaleform.physics.ChainShape
The chain shape currently considered.  points : scaleform.Point[]
Array of vertices in the chain shape, must have more than 1 point.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.physics.ChainShape
The chain shape currently in use.  points : scaleform.Point[]
Array of vertices in the chain loop, must have more than 2 points.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.physics.ChainShape
The chain shape currently in use.  point : scaleform.Point
The vertex for the next shape.  self : scaleform.physics.ChainShape
The chain shape currently in use.  point : scaleform.Point
The vertex of the previous shape.  self : scaleform.physics.ChainShape
The chain shape currently in use.  index : integer
The index at which a new vertex is inserted.  point : scaleform.Point
The vertex to be added.  self : scaleform.physics.CircleShape
The circle shape currently in use.  position : scaleform.Point
The position of the circle shape.  self : scaleform.physics.CircleShape
The circle shape currently used.  dir : scaleform.Point
The specified direction.  integer  self : scaleform.physics.EdgeShape
The edge shape currently in use.  v1 : scaleform.Point
The coordinate of the first edge point.  v2 : scaleform.Point
The coordinate of the second edge point.  self : scaleform.physics.Fixture
The fixture currently in use.  pt : scaleform.Point
The point tested for.  boolean  self : scaleform.physics.MouseJoint
The mouse joint currently considered.  target : scaleform.Point
The target point.  self : scaleform.physics.PolygonShape
The polygon shape to set as a box shape.  hw : number
The half width of the box.  hh : number
The half height of the box.  center : scaleform.Point?
The center of the box.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  angle : number?
The rotation angle of the box.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.physics.PolygonShape
The polygon shape in use.  point : scaleform.Point
The center point set as centroid.  self : scaleform.physics.PolygonShape
The polygon shape in use.  index : integer
The index at which a new vertex is inserted.  point : scaleform.Point
The vertex to be added.  self : scaleform.physics.PolygonShape
The polygon shape to create.  points : scaleform.Point[]
Array of vertices in the shape, must have more than 2 points.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  self : scaleform.physics.Shape
The shape currently in use.  position : scaleform.Point
The world position of the shape.  rotation : number
The world rotation of the shape.  chainShapeChildIndex : integer?
The child shape index.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Rect
Returns the computed aabb for the child shape.  self : scaleform.physics.Shape
The shape currently in use.  position : scaleform.Point
The position of the point.  rotation : number
Rotation of the shape.  point : scaleform.Point
The point tested for.  boolean  self : scaleform.physics.World
The physics World that is to be initialized.  gravity : scaleform.Point?
The gravity of the world.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scale : number?
The scale of the world.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ShapeComponent
The shape component to begin the path in.  point : scaleform.Point
The position to start the path at.  boolean  self : scaleform.ShapeComponent
The shape component to draw the circle in.  center : scaleform.Point
The location of the center of the circle relative to the registration point of the parent actor (in pixels).  radius : number
The radius of the circle.  boolean  self : scaleform.ShapeComponent
The shape component to draw the curve in.  control : scaleform.Point
The position of the control point relative to the registration point of the parent actor.  anchor : scaleform.Point
The position of the next anchor point relative to the registration point of the parent actor.  boolean  self : scaleform.ShapeComponent
The shape component to draw the ellipse in.  center : scaleform.Point
The location of the center of the circle relative to the registration point of the parent actor.  size : scaleform.Size
The width and height of the ellipse.  boolean  self : scaleform.ShapeComponent
The shape component to draw the line in.  point : scaleform.Point
A point indicating the position relative to the registration point of the parent actor.  boolean  self : scaleform.ShapeComponent
The shape component to move the path in.  point : scaleform.Point
The position to move the path to.  boolean  point : scaleform.Point
The point at which the actor is returned.  controllerIdx : integer?
Index of the controller used.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  flags : integer?
Bit flags.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor?
The actor that is topmost or nil if there isn't one.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  Matrix2F
A two-dimensional matrix in row-major order.  scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }  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.BlurFilter
A general implementation for a blur family of filters, which include Glow and Shadow functionality.  scaleform.physics.Body
Interface for physics properties of a vgx actor.  scaleform.physics.ChainShape
Represents a chain shape consisting of multiple line segments. A strictly integral numeric value, with no decimal component.  scaleform.physics.CircleShape
Represents a circle that extends the shape and adds a radius and a local position.  scaleform.physics.DistanceJoint
A distant joint that keeps two bodies at the same distance.  scaleform.physics.EdgeShape
Represents an edge shape consisting of a line segment.  scaleform.physics.FrictionJoint
A friction joint that applies friction to a body.  scaleform.physics.Joint
An interface for the physics properties of the joint between two physics bodies.  scaleform.physics.MouseJoint
A mouse joint for controlling objects with the mouse.  scaleform.physics.PolygonShape
Represents a polygon shape with up to 8 sides.  scaleform.physics.PrismaticJoint
A Prismatic joint that allows two bodies to revolve around a shared point.  scaleform.physics.PulleyJoint
A pulley joint that allows you to simulate bodies connected through pulleys.  scaleform.physics.RevoluteJoint
A revolute joint that allows two bodies to revolve around a shared point.  scaleform.physics.RopeJoint
A rope joint that keeps bodies together in such a way that they act like ropes  scaleform.physics.WeldJoint
A weld joint that essentially glues two bodies together.  scaleform.physics.WheelJoint
A wheel joint that allows two bodies to revolve around a shared point.  scaleform.physics.World
Manages all physics entities, dynamic simulation, and asynchronous queries. true or false.  scaleform.CameraComponent
An interface to camera component.  scaleform.ContainerComponent
An interface to container component.  scaleform.physics.Fixture
An interface to attach shapes to the fixtures.  scaleform.physics.Shape
Represents shape used in fixtures.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }  scaleform.ShapeComponent
An interface to shape component.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }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.
Please send us your comment about this page