Scaleform Studio Lua API Reference: scaleform.physics namespace reference
Description
The Scaleform Studio physics interface.
Objects
Enumerations
Functions
init : |
An table arguments to initialize the returned physics.BodyConstructParams table with. // Only defined members of physics.BodyConstructParams 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 body construct table. |
Other related reference items 
init : |
An table arguments to initialize the returned physics.BodyDef table with. // Only defined members of physics.BodyDef 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 body definition table. |
init : |
An table arguments to initialize the returned physics.CollisionFilter table with. // Only defined members of physics.CollisionFilter 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 collision filter table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.DistanceJointDef table with. // Only defined members of physics.DistanceJointDef 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 distance joint definition table. |
init : |
An table arguments to initialize the returned physics.FixtureDef table with. // Only defined members of physics.FixtureDef 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 fixture definition table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.FrictionJointDef table with. // Only defined members of physics.FrictionJointDef 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 friction joint definition table. |
init : |
An table arguments to initialize the returned physics.GearJointDef table with. // Only defined members of physics.GearJointDef 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 gear joint definition table. |
init : |
An table arguments to initialize the returned physics.JointDef table with. // Only defined members of physics.JointDef 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 Joint definition table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.MassData table with. // Only defined members of physics.MassData 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 mass data table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.MaterialDef table with. // Only defined members of physics.MaterialDef 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 material definition table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.MouseJoint table with. // Only defined members of physics.MouseJoint 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 mouse joint definition table. |
init : |
An table arguments to initialize the returned physics.PrismaticJointDef table with. // Only defined members of physics.PrismaticJointDef 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 prismatic joint definition table. |
init : |
An table arguments to initialize the returned physics.RayCastInput table with. // Only defined members of physics.RayCastInput 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 ray cast input table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.RayCastOutput table with. // Only defined members of physics.RayCastOutput 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 ray cast output table. |
init : |
An table arguments to initialize the returned physics.RevoluteJointDef table with. // Only defined members of physics.RevoluteJointDef 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 revolute joint definition table. |
init : |
An table arguments to initialize the returned physics.RopeJointDef table with. // Only defined members of physics.RopeJointDef 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 rope joint definition table. |
init : |
An table arguments to initialize the returned physics.ShapeDef table with. // Only defined members of physics.ShapeDef 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 shape definition table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.Transform table with. // Only defined members of physics.Transform 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 transform table. |
Other related reference items
init : |
An table arguments to initialize the returned physics.WeldJointDef table with. // Only defined members of physics.WeldJointDef 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 weld joint definition table. |
init : |
An table arguments to initialize the returned physics.WheelJointDef table with. // Only defined members of physics.WheelJointDef 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 wheel joint definition table. |
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.physics.BodyTypesThe different types of physics bodies.
scaleform.physics.JointLimitStatesThe limit state of a joint.
scaleform.physics.JointTypesThe different types of joints.
scaleform.physics.ShapeTypesThe different types of shapes.
scaleform.physics.BodyConstructParams (init) : scaleform.physics.BodyConstructParamsCreate an initialized body construct definition table.
init : scaleform.physics.BodyConstructParams?An table arguments to initialize the returned physics.BodyConstructParams table with. [more...]
scaleform.physics.BodyConstructParamsReturns a fully constructed body construct table.
scaleform.PhysicsBodyComponent.set_body_params (self, bodyParams) Sets the construction parameters to create a new physics body.
scaleform.physics.BodyDef (init) : scaleform.physics.BodyDefCreate an initialized body definition table.
init : scaleform.physics.BodyDef?An table arguments to initialize the returned physics.BodyDef table with. [more...]
scaleform.physics.BodyDefReturns a fully constructed body definition table.
scaleform.physics.CollisionFilter (init) : scaleform.physics.CollisionFilterCreate an initialized collision filter table.
init : scaleform.physics.CollisionFilter?An table arguments to initialize the returned physics.CollisionFilter table with. [more...]
scaleform.physics.CollisionFilterReturns a fully constructed collision filter table.
scaleform.physics.Fixture.set_filter_data (self, filter) Sets the filter data used to filter collision between objects.
scaleform.physics.DistanceJointDef (init) : scaleform.physics.DistanceJointDefCreate an initialized distance joint definition table.
init : scaleform.physics.DistanceJointDef?An table arguments to initialize the returned physics.DistanceJointDef table with. [more...]
scaleform.physics.DistanceJointDefReturns a fully constructed distance joint definition table.
scaleform.physics.FixtureDef (init) : scaleform.physics.FixtureDefCreate an initialized fixture definition table.
init : scaleform.physics.FixtureDef?An table arguments to initialize the returned physics.FixtureDef table with. [more...]
scaleform.physics.FixtureDefReturns a fully constructed fixture definition table.
scaleform.PhysicsBodyComponent.add_fixture (self, fixture) Attaches the fixture to the physics body.
scaleform.physics.FrictionJointDef (init) : scaleform.physics.FrictionJointDefCreate an initialized friction joint definition table.
init : scaleform.physics.FrictionJointDef?An table arguments to initialize the returned physics.FrictionJointDef table with. [more...]
scaleform.physics.FrictionJointDefReturns a fully constructed friction joint definition table.
scaleform.physics.GearJointDef (init) : scaleform.physics.GearJointDefCreate an initialized gear joint definition table.
init : scaleform.physics.GearJointDef?An table arguments to initialize the returned physics.GearJointDef table with. [more...]
scaleform.physics.GearJointDefReturns a fully constructed gear joint definition table.
scaleform.physics.JointDef (init) : scaleform.physics.JointDefCreate an initialized joint definition table.
init : scaleform.physics.JointDef?An table arguments to initialize the returned physics.JointDef table with. [more...]
scaleform.physics.JointDefReturns a fully constructed Joint definition table.
scaleform.physics.Joint.create (world, jointDef) : scaleform.physics.JointCreates a Joint based on the joint data definition.
scaleform.physics.MassData (init) : scaleform.physics.MassDataCreate an initialized mass data table.
init : scaleform.physics.MassData?An table arguments to initialize the returned physics.MassData table with. [more...]
scaleform.physics.MassDataReturns a fully constructed mass data table.
scaleform.physics.Body.set_mass_data (self, data) Sets the mass data of the body.
scaleform.physics.MaterialDef (init) : scaleform.physics.MaterialDefCreate an initialized material definition table.
init : scaleform.physics.MaterialDef?An table arguments to initialize the returned physics.MaterialDef table with. [more...]
scaleform.physics.MaterialDefReturns a fully constructed material definition table.
scaleform.physics.Fixture.set_material (self, material) Sets the material data for the fixture.
scaleform.physics.MouseJointDef (init) : scaleform.physics.MouseJointDefCreate an initialized mouse joint definition table.
init : scaleform.physics.MouseJointDef?An table arguments to initialize the returned physics.MouseJoint table with. [more...]
scaleform.physics.MouseJointDefReturns a fully constructed mouse joint definition table.
scaleform.physics.PrismaticJointDef (init) : scaleform.physics.PrismaticJointDefCreate an initialized prismatic joint definition table.
init : scaleform.physics.PrismaticJointDef?An table arguments to initialize the returned physics.PrismaticJointDef table with. [more...]
scaleform.physics.PrismaticJointDefReturns a fully constructed prismatic joint definition table.
scaleform.physics.RayCastInput (init) : scaleform.physics.RayCastInputCreate an initialized ray cast input table.
init : scaleform.physics.RayCastInput?An table arguments to initialize the returned physics.RayCastInput table with. [more...]
scaleform.physics.RayCastInputReturns a fully constructed ray cast input table.
scaleform.physics.Fixture.cast_ray (self, input, index) : boolean, scaleform.physics.RayCastOutputCast a ray against this shape of the fixture.
scaleform.physics.Shape.ray_cast (self, input, transform, chainShapeChildIndex) : boolean, scaleform.physics.RayCastOutputCast a ray against a child shape.
scaleform.physics.RayCastOutput (init) : scaleform.physics.RayCastOutputCreate an initialized ray cast output table.
init : scaleform.physics.RayCastOutput?An table arguments to initialize the returned physics.RayCastOutput table with. [more...]
scaleform.physics.RayCastOutputReturns a fully constructed ray cast output table.
scaleform.physics.RevoluteJointDef (init) : scaleform.physics.RevoluteJointDefCreate an initialized revolute joint definition table.
init : scaleform.physics.RevoluteJointDef?An table arguments to initialize the returned physics.RevoluteJointDef table with. [more...]
scaleform.physics.RevoluteJointDefReturns a fully constructed revolute joint definition table.
scaleform.physics.RopeJointDef (init) : scaleform.physics.RopeJointDefCreate an initialized rope joint definition table.
init : scaleform.physics.RopeJointDef?An table arguments to initialize the returned physics.RopeJointDef table with. [more...]
scaleform.physics.RopeJointDefReturns a fully constructed rope joint definition table.
scaleform.physics.ShapeDef (init) : scaleform.physics.ShapeDefCreate an initialized shape definition table.
init : scaleform.physics.ShapeDef?An table arguments to initialize the returned physics.ShapeDef table with. [more...]
scaleform.physics.ShapeDefReturns a fully constructed shape definition table.
scaleform.physics.Fixture.create (body, shape, density) : scaleform.physics.FixtureCreates a fixture and attaches it to the body.
scaleform.physics.Transform (init) : scaleform.physics.TransformCreate an initialized transform table.
init : scaleform.physics.Transform?An table arguments to initialize the returned physics.Transform table with. [more...]
scaleform.physics.TransformReturns a fully constructed transform table.
scaleform.physics.WeldJointDef (init) : scaleform.physics.WeldJointDefCreate an initialized weld joint definition table.
init : scaleform.physics.WeldJointDef?An table arguments to initialize the returned physics.WeldJointDef table with. [more...]
scaleform.physics.WeldJointDefReturns a fully constructed weld joint definition table.
scaleform.physics.WheelJointDef (init) : scaleform.physics.WheelJointDefCreate an initialized wheel joint definition table.
init : scaleform.physics.WheelJointDef?An table arguments to initialize the returned physics.WheelJointDef table with. [more...]
scaleform.physics.WheelJointDefReturns a fully constructed wheel joint definition table.
self : scaleform.PhysicsBodyComponentThe physics body component that owns the body.
bodyParams : scaleform.physics.BodyConstructParamsData required to create a new physics body.
self : scaleform.physics.FixtureThe fixture currently in use.
filter : scaleform.physics.CollisionFilterThe filter used to define the collision of the fixture.
self : scaleform.PhysicsBodyComponentThe physics body component that owns the body.
fixture : scaleform.physics.FixtureDefThe fixture definition data to create fixture.
world : scaleform.physics.WorldThe World in which the joint exists.
jointDef : scaleform.physics.JointDefThe joint data definition to create joint.
scaleform.physics.JointThe newly created Joint.
self : scaleform.physics.BodyThe physics body currently in use.
data : scaleform.physics.MassDataThe mass data of the body.
self : scaleform.physics.FixtureThe fixture currently in use.
material : scaleform.physics.MaterialDefThe material data definition.
self : scaleform.physics.FixtureThe fixture currently in use.
input : scaleform.physics.RayCastInputThe input line end point.
index : integerThe index of the child the ray gets cast against.
boolean scaleform.physics.RayCastOutputthe output line end point if the operation is successful.
self : scaleform.physics.ShapeThe shape currently in use.
input : scaleform.physics.RayCastInputThe ray-cast input parameters.
transform : scaleform.physics.TransformThe transform to be applied to the shape.
chainShapeChildIndex : integer?The chain child shape index.
boolean scaleform.physics.RayCastOutputThe ray-cast results
body : scaleform.physics.BodyThe physics body to which the fixture is attached.
shape : scaleform.physics.ShapeDefThe shape definition data.
density : numberDensity of the body.
scaleform.physics.FixtureThe newly created Fixture.
scaleform.PhysicsBodyComponentDescribes a Actor's physical properties. A strictly integral numeric value, with no decimal component.true or false.A numeric value.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.