Scaleform Studio Lua API Reference: scaleform.physics.Joint object reference
scaleform.physics.Joint object reference
Description
An interface for the physics properties of the joint between two physics bodies.
Inheritance 
Constructors and accessors
Functions
Parameters
Returns
self : |
The joint currently in use. |
boolean |
Whether the bodies are inactive or not. |
Parameters
Returns
self : |
The joint currently in use. |
boolean |
Whether the physics implementation is alive. |
Parameters
Returns
self : |
The joint currently in use. |
|
The anchor point of the first body. |
 |
Gets the anchor point of the second body of the bodies that are currently linked through this joint.
|
Parameters
Returns
self : |
The joint currently in use. |
|
The anchor point of the second body. |
Parameters
Returns
self : |
The joint currently in use. |
|
The body linked through the joint. |
Parameters
Returns
self : |
The joint currently in use. |
|
The body linked through the joint. |
Parameters
Returns
self : |
The joint currently in use. |
boolean |
Whether the connected bodies collide or not. |
Parameters
Returns
world : |
The World in which the joint exists. | |
jointDef : |
The joint data definition to create joint. |
|
The newly created Joint. |
Parameters
Returns
self : |
The joint to remove. |
| This function does not return any values. |
Parameters
Returns
self : |
The joint currently in use. | |
inv_dt : | number |
The inverse time step. |
number |
The reaction force. |
Parameters
Returns
self : |
The joint currently in use. | |
inv_dt : | number |
The inverse time step. |
number |
The reaction torque. |
scaleform.physics.DistanceJointA distant joint that keeps two bodies at the same distance.
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.MouseJointA mouse joint for controlling objects with the mouse.
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.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.Body.joint_list (self) : scaleform.physics.Joint[]Gets a list of Joints that are attached to this body.
scaleform.physics.GearJoint.joint_1 (self) : scaleform.physics.JointGets the joints linked to the gear joint.
scaleform.physics.GearJoint.joint_2 (self) : scaleform.physics.JointGets the joints linked to the gear joint.
scaleform.physics.Joint.create (world, jointDef) : scaleform.physics.JointCreates a Joint based on the joint data definition.
scaleform.physics.Joint.active (self) : booleanDetermines if either body is inactive.
self : scaleform.physics.JointThe joint currently in use.
boolean scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies. true or false.
scaleform.physics.Joint.alive (self) : booleanDetermines if the physics implementation is alive.
self : scaleform.physics.JointThe joint currently in use.
boolean scaleform.physics.Joint.anchor_a (self) : scaleform.PointGets the anchor point of the first body of the bodies that are currently linked through this joint.
self : scaleform.physics.JointThe joint currently in use.
scaleform.PointThe anchor point of the first body.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.Joint.anchor_b (self) : scaleform.PointGets the anchor point of the second body of the bodies that are currently linked through this joint.
self : scaleform.physics.JointThe joint currently in use.
scaleform.PointThe anchor point of the second body.
scaleform.physics.Joint.body_a (self) : scaleform.physics.BodyReturns the first body of the bodies that are currently linked through this joint.
self : scaleform.physics.JointThe joint currently in use.
scaleform.physics.BodyThe body linked through the joint.
scaleform.physics.BodyInterface for physics properties of a vgx actor.
scaleform.physics.Joint.body_b (self) : scaleform.physics.BodyReturns the second body of the bodies that are currently linked through this joint.
self : scaleform.physics.JointThe joint currently in use.
scaleform.physics.BodyThe body linked through the joint.
scaleform.physics.Joint.collide_connected (self) : booleanReturns the flags that lets us know whether connected bodies collide.
self : scaleform.physics.JointThe joint currently in use.
boolean 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.
scaleform.physics.WorldManages all physics entities, dynamic simulation, and asynchronous queries.
scaleform.physics.JointDef (init) : scaleform.physics.JointDefCreate an initialized joint definition table.
scaleform.physics.Joint.destroy (self) Destroys the joint in the world.
self : scaleform.physics.JointThe joint to remove.
scaleform.physics.Joint.reaction_force (self, inv_dt) : numberGets the reaction force given the inverse time step.
self : scaleform.physics.JointThe joint currently in use.
inv_dt : numberThe inverse time step.
numberA numeric value. scaleform.physics.Joint.reaction_torque (self, inv_dt) : numberGets the reaction torque given the inverse time step.
self : scaleform.physics.JointThe joint currently in use.
inv_dt : numberThe inverse time step.
number scaleform.physics.Joint.type (self) : scaleform.physics.JointTypesReturns the type of the joint.
self : scaleform.physics.JointThe joint currently considered.
scaleform.physics.JointTypesThe type of the joint.
scaleform.physics.JointTypesThe different types of joints.
self : scaleform.physics.BodyThe physics body currently in use.
scaleform.physics.Joint[]The list of Joints that are attached to this body.
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.GearJointThe gear joint currently in use.
scaleform.physics.JointThe first joint linked as gear joint.
self : scaleform.physics.GearJointThe gear joint currently in use.
scaleform.physics.JointThe second joint linked as gear joint.A string of characters.
init : scaleform.physics.JointDef?An table arguments to initialize the returned physics.JointDef table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.physics.JointDefReturns a fully constructed Joint definition table.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.