MOAIBox2DMouseJoint Class Reference

Inheritance diagram for MOAIBox2DMouseJoint:

List of all members.

Function List
	getDampingRatio
	getFrequency
	getMaxForce
	getTarget
	setDampingRatio
	setFrequency
	setMaxForce
	setTarget

---

Function Documentation

getDampingRatio

See Box2D documentation.

---

function getDampingRatio ( MOAIBox2DMouseJoint self )

Parameters:

self	( MOAIBox2DMouseJoint )

Returns:

dampingRatio ( number )

getFrequency

See Box2D documentation.

---

function getFrequency ( MOAIBox2DMouseJoint self )

Parameters:

self	( MOAIBox2DMouseJoint )

Returns:

frequency ( number )

getMaxForce

See Box2D documentation.

---

function getMaxForce ( MOAIBox2DMouseJoint self )

Parameters:

self	( MOAIBox2DMouseJoint )

Returns:

maxForce ( number )

getTarget

See Box2D documentation.

---

function getTarget ( MOAIBox2DMouseJoint self )

Parameters:

self	( MOAIBox2DMouseJoint )

Returns:

x ( number ), y ( number )

setDampingRatio

See Box2D documentation.

---

function setDampingRatio ( MOAIBox2DMouseJoint self [, number dampingRatio ] )

Parameters:

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

Returns:

nil

setFrequency

See Box2D documentation.

---

function setFrequency ( MOAIBox2DMouseJoint self [, number frequency ] )

Parameters:

self	( MOAIBox2DMouseJoint )
frequency	( number ) Optional. in Hz. Default value is 0.

Returns:

nil

setMaxForce

See Box2D documentation.

---

function setMaxForce ( MOAIBox2DMouseJoint self [, number maxForce ] )

Parameters:

self	( MOAIBox2DMouseJoint )
maxForce	( number ) Optional. in kg * units / s^2 converted to N [kg * m / s^2]. Default value is 0.

Returns:

nil

setTarget

See Box2D documentation.

---

function setTarget ( MOAIBox2DMouseJoint self [, number x, number y ] )

Parameters:

self	( MOAIBox2DMouseJoint )
x	( number ) Optional. in units, world coordinates, converted to meters. Default value is 0.
y	( number ) Optional. in units, world coordinates, converted to meters. Default value is 0.

Returns:

nil