Scaleform Studio Lua API Reference: scaleform.physics.WeldJoint object reference
scaleform.physics.WeldJoint object reference
Description
A weld joint that essentially glues two bodies together.
Inheritance 
Functions
Parameters
Returns
self : |
The weld joint currently in use. |
number |
The damping ratio. |
Parameters
Returns
self : |
The weld joint currently in use. |
number |
The joint frequency. |
Parameters
Returns
self : |
The weld joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The weld joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The weld joint currently in use. |
number |
The angle between bodies. |
Parameters
Returns
self : |
The weld joint currently in use. | |
length : | number |
The damping ratio. |
| This function does not return any values. |
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.WeldJoint.damping_ratio (self) : numberGets the damping ratio.
self : scaleform.physics.WeldJointThe weld joint currently in use.
number scaleform.physics.WeldJointA weld joint that essentially glues two bodies together. A numeric value.
scaleform.physics.WeldJoint.frequency (self) : numberGets the joint natural frequency.
self : scaleform.physics.WeldJointThe weld joint currently in use.
number scaleform.physics.WeldJoint.local_anchor_a (self) : scaleform.PointReturns the local anchor point relative to body A.
self : scaleform.physics.WeldJointThe weld joint currently in use.
scaleform.PointThe anchor point.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.WeldJoint.local_anchor_b (self) : scaleform.PointReturns the local anchor point relative to body B.
self : scaleform.physics.WeldJointThe weld joint currently in use.
scaleform.PointThe anchor point.
scaleform.physics.WeldJoint.reference_angle (self) : numberReturns the constrained angle between the bodies.
self : scaleform.physics.WeldJointThe weld joint currently in use.
number scaleform.physics.WeldJoint.set_damping_ratio (self, length) Sets the damping ratio.
self : scaleform.physics.WeldJointThe weld joint currently in use.
length : numberThe damping ratio.
scaleform.physics.WeldJoint.set_frequency (self, hz) Sets the joint natural frequency.
self : scaleform.physics.WeldJointThe weld joint currently in use.
hz : numberThe joint frequency.A string of characters.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.