MOAIBox2DPrismaticJoint Class Reference

Inheritance diagram for MOAIBox2DPrismaticJoint:

Function List
	getJointSpeed
	getJointTranslation
	getLowerLimit
	getMotorForce
	getMotorSpeed
	getUpperLimit
	isLimitEnabled
	isMotorEnabled
	setLimit
	setLimitEnabled
	setMaxMotorForce
	setMotor
	setMotorSpeed
	setMotorEnabled

Additional Inherited Members
Function List inherited from MOAIBox2DJoint
	destroy
	getAnchorA
	getAnchorB
	getBodyA
	getBodyB
	getReactionForce
	getReactionTorque

Function Documentation

getJointSpeed

See Box2D documentation.

---

function getJointSpeed ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number jointSpeed

getJointTranslation

See Box2D documentation.

---

function getJointTranslation ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number jointTranslation

getLowerLimit

See Box2D documentation.

---

function getLowerLimit ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number lowerLimit

getMotorForce

See Box2D documentation.

---

function getMotorForce ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number motorForce

getMotorSpeed

See Box2D documentation.

---

function getMotorSpeed ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number motorSpeed

getUpperLimit

See Box2D documentation.

---

function getUpperLimit ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

number upperLimit

isLimitEnabled

See Box2D documentation.

---

function isLimitEnabled ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

boolean limitEnabled

isMotorEnabled

See Box2D documentation.

---

function isMotorEnabled ( MOAIBox2DPrismaticJoint self )

Parameters

MOAIBox2DPrismaticJoint

self

Returns

boolean motorEnabled

setLimit

See Box2D documentation.

---

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

Parameters

MOAIBox2DPrismaticJoint	self
number	lower Optional. in units, converted to meters. Default value is 0.
number	upper Optional. in units, converted to meters. Default value is 0.

Returns

nil

setLimitEnabled

See Box2D documentation.

---

function setLimitEnabled ( MOAIBox2DPrismaticJoint self [, boolean enabled ] )

Parameters

MOAIBox2DPrismaticJoint	self
boolean	enabled Optional. Default value is 'true'

Returns

nil

setMaxMotorForce

See Box2D documentation.

---

function setMaxMotorForce ( MOAIBox2DPrismaticJoint self [, number maxMotorForce ] )

Parameters

MOAIBox2DPrismaticJoint	self
number	maxMotorForce Optional. in kg * units / s^2, converted to N [kg * m / s^2]. 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 ( MOAIBox2DPrismaticJoint self [, number speed, number maxForce, boolean forceEnable ] )

Parameters

MOAIBox2DPrismaticJoint	self
number	speed Optional. in units/s converted to m/s. Default value is 0.
number	maxForce Optional. in kg * units / s^2, converted to N [kg * m / s^2]. Default value is 0.
boolean	forceEnable Optional. Default value is false.

Returns

nil

setMotorEnabled

See Box2D documentation.

---

function setMotorEnabled ( MOAIBox2DPrismaticJoint self [, boolean enabled ] )

Parameters

MOAIBox2DPrismaticJoint	self
boolean	enabled Optional. Default value is 'true'

Returns

nil

setMotorSpeed

See Box2D documentation.

---

function setMotorSpeed ( MOAIBox2DPrismaticJoint self [, number motorSpeed ] )

Parameters

MOAIBox2DPrismaticJoint	self
number	motorSpeed Optional. in units/s, converted to m/s. Default value is 0.

Returns

nil