Scaleform Studio Lua API Reference: scaleform.physics.GearJoint object reference
scaleform.physics.GearJoint object reference
Description
A gear joint that keeps bodies together in such a way that they act like gears.
Inheritance 
Functions
Parameters
Returns
self : |
The gear joint currently in use. |
|
The first joint linked as gear joint. |
Parameters
Returns
self : |
The gear joint currently in use. |
|
The second joint linked as gear joint. |
Parameters
Returns
self : |
The gear joint currently in use. |
number |
The ratio of the gear joint. |
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.GearJoint.joint_1 (self) : scaleform.physics.JointGets the joints linked to the gear joint.
self : scaleform.physics.GearJointThe gear joint currently in use.
scaleform.physics.JointThe first joint linked as gear joint.
scaleform.physics.GearJointA gear joint that keeps bodies together in such a way that they act like gears.
scaleform.physics.GearJoint.joint_2 (self) : scaleform.physics.JointGets the joints linked to the gear joint.
self : scaleform.physics.GearJointThe gear joint currently in use.
scaleform.physics.JointThe second joint linked as gear joint.
scaleform.physics.GearJoint.ratio (self) : numberGets the ratio of the gear joint.
self : scaleform.physics.GearJointThe gear joint currently in use.
numberA numeric value. scaleform.physics.GearJoint.set_ratio (self, ratio) Sets the ratio of the gear joint.
self : scaleform.physics.GearJointThe gear joint currently in use.
ratio : numberThe ratio of the gear joint.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.