MOAIBox2DPrismaticJoint Class Reference

Inheritance diagram for MOAIBox2DPrismaticJoint:

List of all members.

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

---

Function Documentation

getJointSpeed

See Box2D documentation.

---

function getJointSpeed ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

jointSpeed ( number )

getJointTranslation

See Box2D documentation.

---

function getJointTranslation ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

jointTranslation ( number )

getLowerLimit

See Box2D documentation.

---

function getLowerLimit ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

lowerLimit ( number )

getMotorForce

See Box2D documentation.

---

function getMotorForce ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

motorForce ( number )

getMotorSpeed

See Box2D documentation.

---

function getMotorSpeed ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

motorSpeed ( number )

getUpperLimit

See Box2D documentation.

---

function getUpperLimit ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

upperLimit ( number )

isLimitEnabled

See Box2D documentation.

---

function isLimitEnabled ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

limitEnabled ( boolean )

isMotorEnabled

See Box2D documentation.

---

function isMotorEnabled ( MOAIBox2DPrismaticJoint self )

Parameters:

self	( MOAIBox2DPrismaticJoint )

Returns:

motorEnabled ( boolean )

setLimit

See Box2D documentation.

---

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

Parameters:

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

Returns:

nil

setLimitEnabled

See Box2D documentation.

---

function setLimitEnabled ( MOAIBox2DPrismaticJoint self [, boolean enabled ] )

Parameters:

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

Returns:

nil

setMaxMotorForce

See Box2D documentation.

---

function setMaxMotorForce ( MOAIBox2DPrismaticJoint self [, number maxMotorForce ] )

Parameters:

self	( MOAIBox2DPrismaticJoint )
maxMotorForce	( number ) 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:

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

Returns:

nil

setMotorEnabled

See Box2D documentation.

---

function setMotorEnabled ( MOAIBox2DPrismaticJoint self [, boolean enabled ] )

Parameters:

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

Returns:

nil

setMotorSpeed

See Box2D documentation.

---

function setMotorSpeed ( MOAIBox2DPrismaticJoint self [, number motorSpeed ] )

Parameters:

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

Returns:

nil