MOAIBox2DRevoluteJoint Class Reference

Inheritance diagram for MOAIBox2DRevoluteJoint:

List of all members.

Function List
	getJointAngle
	getJointSpeed
	getLowerLimit
	getMotorSpeed
	getMotorTorque
	getUpperLimit
	isLimitEnabled
	isMotorEnabled
	setLimit
	setLimitEnabled
	setMaxMotorTorque
	setMotor
	setMotorSpeed
	setMotorEnabled

---

Function Documentation

getJointAngle

See Box2D documentation.

---

function getJointAngle ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

angle ( number )

getJointSpeed

See Box2D documentation.

---

function getJointSpeed ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

jointSpeed ( number )

getLowerLimit

See Box2D documentation.

---

function getLowerLimit ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

lowerLimit ( number )

getMotorSpeed

See Box2D documentation.

---

function getMotorSpeed ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

motorSpeed ( number )

getMotorTorque

See Box2D documentation.

---

function getMotorTorque ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

motorTorque ( number )

getUpperLimit

See Box2D documentation.

---

function getUpperLimit ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

upperLimit ( number )

isLimitEnabled

See Box2D documentation.

---

function isLimitEnabled ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

limitEnabled ( boolean )

isMotorEnabled

See Box2D documentation.

---

function isMotorEnabled ( MOAIBox2DRevoluteJoint self )

Parameters:

self	( MOAIBox2DRevoluteJoint )

Returns:

motorEnabled ( boolean )

setLimit

See Box2D documentation.

---

function setLimit ( MOAIBox2DRevoluteJoint self [, number lower, number upper ] )

Parameters:

self	( MOAIBox2DRevoluteJoint )
lower	( number ) Optional. in degrees, converted to radians. Default value is 0.
upper	( number ) Optional. in degrees, converted to radians. Default value is 0.

Returns:

nil

setLimitEnabled

See Box2D documentation.

---

function setLimitEnabled ( MOAIBox2DRevoluteJoint self [, boolean enabled ] )

Parameters:

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

Returns:

nil

setMaxMotorTorque

See Box2D documentation.

---

function setMaxMotorTorque ( MOAIBox2DRevoluteJoint self [, number maxMotorTorque ] )

Parameters:

self	( MOAIBox2DRevoluteJoint )
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 ( MOAIBox2DRevoluteJoint self [, number speed, number maxMotorTorque, boolean forceEnable ] )

Parameters:

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

Returns:

nil

setMotorEnabled

See Box2D documentation.

---

function setMotorEnabled ( MOAIBox2DRevoluteJoint self [, boolean enabled ] )

Parameters:

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

Returns:

nil

setMotorSpeed

See Box2D documentation.

---

function setMotorSpeed ( MOAIBox2DRevoluteJoint self [, number motorSpeed ] )

Parameters:

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

Returns:

nil