MOAIBox2DWheelJoint Class Reference

Inheritance diagram for MOAIBox2DWheelJoint:

List of all members.

Function List
	getJointTranslation
	getJointSpeed
	isMotorEnabled
	getMotorSpeed
	getSpringDampingRatio
	getMaxMotorTorque
	getMotorTorque
	getSpringFrequencyHz
	setMotor
	setMotorSpeed
	setMotorEnabled
	setMaxMotorTorque
	setSpringDampingRatio
	setSpringFrequencyHz

---

Function Documentation

getJointSpeed

See Box2D documentation.

---

function getJointSpeed ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

jointSpeed ( number )

getJointTranslation

See Box2D documentation.

---

function getJointTranslation ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

jointTranslation ( number )

getMaxMotorTorque

See Box2D documentation.

---

function getMaxMotorTorque ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

maxMotorTorque ( number )

getMotorSpeed

See Box2D documentation.

---

function getMotorSpeed ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

motorSpeed ( number )

getMotorTorque

See Box2D documentation.

---

function getMotorTorque ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

torque ( number )

getSpringDampingRatio

See Box2D documentation.

---

function getSpringDampingRatio ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

dampingRatio ( number )

getSpringFrequencyHz

See Box2D documentation.

---

function getSpringFrequencyHz ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

springFrequency ( number )

isMotorEnabled

See Box2D documentation.

---

function isMotorEnabled ( MOAIBox2DWheelJoint self )

Parameters:

self	( MOAIBox2DWheelJoint )

Returns:

motorEnabled ( boolean )

setMaxMotorTorque

See Box2D documentation.

---

function setMaxMotorTorque ( MOAIBox2DWheelJoint self [, number maxMotorTorque ] )

Parameters:

self	( MOAIBox2DWheelJoint )
maxMotorTorque	( number ) Optional. in (kg * units / s^2) * units, converted to N-m. Default value is 0.

Returns:

nil

setMotor

See Box2D documentation. If speed is determined to be zero, the motor is disabled, unless forceEnable is set.

---

function setMotor ( MOAIBox2DWheelJoint self [, number speed, number maxMotorTorque, boolean forceEnable ] )

Parameters:

self	( MOAIBox2DWheelJoint )
speed	( number ) Optional. in degrees/s, converted to radians/s. Default value is 0.
maxMotorTorque	( number ) Optional. in (kg * units / s^2) * units, converted from N-m. Default value is 0.
forceEnable	( boolean ) Optional. Default value is false.

Returns:

nil

setMotorEnabled

See Box2D documentation.

---

function setMotorEnabled ( MOAIBox2DWheelJoint self [, boolean enabled ] )

Parameters:

self	( MOAIBox2DWheelJoint )
enabled	( boolean ) Optional. Default value is 'true'

Returns:

nil

setMotorSpeed

See Box2D documentation.

---

function setMotorSpeed ( MOAIBox2DWheelJoint self [, number motorSpeed ] )

Parameters:

self	( MOAIBox2DWheelJoint )
motorSpeed	( number ) Optional. in degrees/s, converted to radians/s. Default value is 0.

Returns:

nil

setSpringDampingRatio

See Box2D documentation.

---

function setSpringDampingRatio ( MOAIBox2DWheelJoint self [, number dampingRatio ] )

Parameters:

self	( MOAIBox2DWheelJoint )
dampingRatio	( number ) Optional. Default value is 0.

Returns:

nil

setSpringFrequencyHz

See Box2D documentation.

---

function setSpringFrequencyHz ( MOAIBox2DWheelJoint self [, number springFrequencyHz ] )

Parameters:

self	( MOAIBox2DWheelJoint )
springFrequencyHz	( number ) Optional. in Hz. Default value is 0.

Returns:

nil