Scaleform Studio Lua API Reference: scaleform.physics.WheelJoint object reference
scaleform.physics.WheelJoint object reference
Description
A wheel joint that allows two bodies to revolve around a shared point.
Inheritance 
Functions
Parameters
Returns
self : |
The wheel joint currently in use. |
number |
The joint speed. |
Parameters
Returns
self : |
The wheel joint currently in use. |
number |
The joint translation. |
Parameters
Returns
self : |
The wheel joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The wheel joint currently in use. |
|
The anchor point. |
Parameters
Returns
self : |
The wheel joint currently in use. |
|
The axis point. |
Parameters
Returns
self : |
The wheel joint currently in use. |
number |
The motor torque. |
Parameters
Returns
self : |
The wheel joint currently in use. |
boolean |
Whether the motor is working. |
Parameters
Returns
self : |
The wheel joint currently in use. |
number |
The speed of the motor. |
Parameters
Returns
self : |
The wheel joint currently in use. | |
inv_dt : | number |
the inverse time step. |
number |
The motor torque. |
Parameters
Returns
self : |
The wheel joint currently in use. | |
torque : | number |
The motor torque. |
| This function does not return any values. |
Parameters
Returns
self : |
The wheel 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 wheel joint currently in use. | |
speed : | number |
The motor speed. |
| This function does not return any values. |
Parameters
Returns
self : |
The wheel joint currently in use. | |
ratio : | number |
The spring damping ratio. |
| This function does not return any values. |
Parameters
Returns
self : |
The wheel joint currently in use. | |
freq : | number |
The spring frequency. |
| This function does not return any values. |
Setting the frequency to zero disables the spring.
Parameters
Returns
self : |
The wheel joint currently in use. |
number |
The spring damping ratio. |
scaleform.physics.JointAn interface for the physics properties of the joint between two physics bodies.
scaleform.physics.WheelJoint.joint_speed (self) : numberReturns the current joint speed.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
number scaleform.physics.WheelJointA wheel joint that allows two bodies to revolve around a shared point. A numeric value.
scaleform.physics.WheelJoint.joint_translation (self) : numberReturns the current joint translation.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
number scaleform.physics.WheelJoint.local_anchor_a (self) : scaleform.PointReturns the local anchor point relative to body A.
self : scaleform.physics.WheelJointThe wheel 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.WheelJoint.local_anchor_b (self) : scaleform.PointReturns the local anchor point relative to body B.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
scaleform.PointThe anchor point.
scaleform.physics.WheelJoint.local_axis_a (self) : scaleform.PointReturns the local joint axis relative to body A.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
scaleform.PointThe axis point.
scaleform.physics.WheelJoint.max_motor_torque (self) : numberGets the maximum torque for the joint motor.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
number scaleform.physics.WheelJoint.motor_enabled (self) : booleanChecks if the joint motor is enabled and working.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
booleantrue or false. scaleform.physics.WheelJoint.motor_speed (self) : numberGets the speed for the joint motor.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
number scaleform.physics.WheelJoint.motor_torque (self, inv_dt) : numberGets the torque on the joint motor.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
inv_dt : numberthe inverse time step.
number scaleform.physics.WheelJoint.set_max_motor_torque (self, torque) Sets the maximum torque for the joint motor.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
torque : numberThe motor torque.
scaleform.physics.WheelJoint.set_motor_enabled (self, enable) Enables the joint motor.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
enable : booleanA flag to start/stop the joint motor.
scaleform.physics.WheelJoint.set_motor_speed (self, speed) Sets the motor speed of the joint.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
speed : numberThe motor speed.
scaleform.physics.WheelJoint.set_spring_damping_ratio (self, ratio) Sets the spring damping ratio.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
ratio : numberThe spring damping ratio.
scaleform.physics.WheelJoint.set_spring_frequency (self, freq) Sets the spring frequency.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
freq : numberThe spring frequency.
scaleform.physics.WheelJoint.spring_damping_ratio (self) : numberGets the spring damping ratio.
self : scaleform.physics.WheelJointThe wheel joint currently in use.
number scaleform.physics.WheelJoint.spring_frequency (self) : numberGets the spring frequency.
self : scaleform.physics.WheelJointThe wheel 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.