Scaleform Studio Lua API Reference: scaleform.physics.RevoluteJoint object reference
scaleform.physics.RevoluteJoint object reference
Description
A revolute joint that allows two bodies to revolve around a shared point.
Inheritance 
Functions
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The joint angle. |
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The joint speed. |
Parameters
Returns
self : |
The revolute joint currently in use. |
boolean |
Returns true if limits are enabled and false otherwise. |
Parameters
Returns
self : |
The revolute joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The revolute joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The lower limit. |
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The maximum motor torque. |
Parameters
Returns
self : |
The revolute joint currently in use. |
boolean |
Whether the motor is working. |
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The speed of the motor. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
inv_dt : | number |
The inverse time step. |
number |
The torque on the joint motor. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
inv_dt : | number |
The inverse time step. |
number |
The reaction force. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
inv_dt : | number |
The inverse time step. |
number |
The reaction torque. |
Parameters
Returns
self : |
The revolute joint currently in use. |
number |
The angle between bodies. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
lower : | number |
The lower limit. |
upper : | number |
The upper limit. |
| This function does not return any values. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
enable : | boolean |
A flag to enable/disable the limits of the joint. |
| This function does not return any values. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
torque : | number |
The motor torque. |
| This function does not return any values. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
enable : | boolean |
A flag to start/stop the joint motor. |
| This function does not return any values. |
Parameters
Returns
self : |
The revolute joint currently in use. | |
speed : | number |
The motor speed. |
| This function does not return any values. |
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.RevoluteJoint.joint_angle (self) : numberReturns the current joint angle in radians.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJointA revolute joint that allows two bodies to revolve around a shared point. A numeric value.
scaleform.physics.RevoluteJoint.joint_speed (self) : numberReturns the current joint speed.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJoint.limit_enabled (self) : booleanCheck whether the joint limits are enabled.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
booleantrue or false. scaleform.physics.RevoluteJoint.local_anchor_a (self) : scaleform.PointReturns the local anchor point relative to body A.
self : scaleform.physics.RevoluteJointThe revolute 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.RevoluteJoint.local_anchor_b (self) : scaleform.PointReturns the local anchor point relative to body A.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
scaleform.PointThe anchor point.
scaleform.physics.RevoluteJoint.lower_limit (self) : numberReturns the lower limit of the joint.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJoint.max_motor_torque (self) : numberGets the maximum torque for the joint motor.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJoint.motor_enabled (self) : booleanChecks if the joint motor is enabled and working.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
boolean scaleform.physics.RevoluteJoint.motor_speed (self) : numberGets the speed for the joint motor.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJoint.motor_torque (self, inv_dt) : numberGets the torque on the joint motor.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
inv_dt : numberThe inverse time step.
number scaleform.physics.RevoluteJoint.reaction_force (self, inv_dt) : numberGets the reaction force given the inverse time step.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
inv_dt : numberThe inverse time step.
number scaleform.physics.RevoluteJoint.reaction_torque (self, inv_dt) : numberGets the reaction torque given the inverse time step.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
inv_dt : numberThe inverse time step.
number scaleform.physics.RevoluteJoint.reference_angle (self) : numberReturns the constrained angle between the bodies.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
number scaleform.physics.RevoluteJoint.set_limits (self, lower, upper) Set the joint limits.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
lower : numberThe lower limit.
upper : numberThe upper limit.
scaleform.physics.RevoluteJoint.set_limit_enabled (self, enable) Enables the joint limits.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
enable : booleanA flag to enable/disable the limits of the joint.
scaleform.physics.RevoluteJoint.set_max_motor_torque (self, torque) Sets the maximum torque for the joint motor.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
torque : numberThe motor torque.
scaleform.physics.RevoluteJoint.set_motor_enabled (self, enable) Enables the joint motor.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
enable : booleanA flag to start/stop the joint motor.
scaleform.physics.RevoluteJoint.set_motor_speed (self, speed) Sets the motor speed of the joint.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
speed : numberThe motor speed.
scaleform.physics.RevoluteJoint.upper_limit (self) : numberReturns the upper limit of the joint.
self : scaleform.physics.RevoluteJointThe revolute joint currently in use.
numberA 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.