Scaleform Studio Lua API Reference: scaleform.physics.DistanceJoint object reference
scaleform.physics.DistanceJoint object reference
Description
A distant joint that keeps two bodies at the same distance.
Inheritance 
Functions
Parameters
Returns
self : |
Current distance joint connecting two bodies. |
number |
The damping ratio. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. |
number |
The frequency in hz. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. |
number |
The distance between the two bodies. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. |
|
The local anchor point. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. |
|
The local anchor point. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. | |
ratio : | number |
The damping ratio. |
| This function does not return any values. |
Parameters
Returns
self : |
Current distance joint connecting two bodies. | |
freq : | number |
The frequency in hz. |
| This function does not return any values. |
The frequency, set in hz, establishes how fast the bodies react to restore equilibrium once it's broken. Should always be below half the current timestep (usually below 30hz).
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.DistanceJoint.damping_ratio (self) : numberGets the damping ratio.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
number scaleform.physics.DistanceJointA distant joint that keeps two bodies at the same distance. A numeric value.
scaleform.physics.DistanceJoint.frequency (self) : numberGets the frequency.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
number scaleform.physics.DistanceJoint.length (self) : numberGets the equilibrium distance between the two bodies.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
number scaleform.physics.DistanceJoint.local_anchor_a (self) : scaleform.PointReturns the local anchor point relative to body A.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
scaleform.PointThe local anchor point.
scaleform.PointPoint should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }
scaleform.physics.DistanceJoint.local_anchor_b (self) : scaleform.PointReturns the local anchor point relative to body B.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
scaleform.PointThe local anchor point.
scaleform.physics.DistanceJoint.set_damping_ratio (self, ratio) Sets the damping ratio, typically from 0.0f to 1.0f, but could be larger.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
ratio : numberThe damping ratio.
scaleform.physics.DistanceJoint.set_frequency (self, freq) Sets the frequency.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
freq : numberThe frequency in hz.
scaleform.physics.DistanceJoint.set_length (self, length) Sets the equilibrium distance between the two bodies.
self : scaleform.physics.DistanceJointCurrent distance joint connecting two bodies.
length : numberThe distance between the two bodies.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.