Joint

Description:

  Attach multiple bodies together to interact in unique ways.

type

Type: Function.

Description:

  Gets the type of the object as a string.

Signature:

type: function(self: Joint): string

Returns:

Return Type	Description
string	The type as a string.

Of

Type: Function.

Description:

  Checks whether an object is of a certain type. If the object has the type with the specified name in its hierarchy, this function will return true.

Signature:

typeOf: function(self: Joint, type_name: string): boolean

Parameters:

Parameter	Type	Description
type_name	string	The name of the type to check for.

Returns:

Return Type	Description
boolean	True if the object is of the specified type, false otherwise.

release

Type: Function.

Description:

  Destroys the object's Lua reference. The object will be completely deleted if it's not referenced by any other LÖVE object or thread. This method can be used to immediately clean up resources without waiting for Lua's garbage collector.

Signature:

release: function(self: Joint): boolean

Returns:

Return Type	Description
boolean	True if the object was released by this call, false if it had been previously released.

destroy

Type: Function.

Description:

  Explicitly destroys the Joint. An error will occur if you attempt to use the object after calling this function. In 0.7.2, when you don't have time to wait for garbage collection, this function may be used to free the object immediately.

Signature:

destroy: function(self: Joint)

isDestroyed

Type: Function.

Description:

  Gets whether the Joint is destroyed. Destroyed joints cannot be used.

Signature:

isDestroyed: function(self: Joint): boolean

Returns:

Return Type	Description
boolean	Whether the Joint is destroyed.

getType

Type: Function.

Description:

  Gets a string representing the type.

Signature:

getType: function(self: Joint): string

Returns:

Return Type	Description
string	A string with the name of the Joint type.

getBodies

Type: Function.

Description:

  Gets the bodies that the Joint is attached to.

Signature:

getBodies: function(self: Joint): Body, Body

Returns:

Return Type	Description
Body	The first Body.
Body	The second Body.

getAnchors

Type: Function.

Description:

  Get the anchor points of the joint.

Signature:

getAnchors: function(self: Joint): number, number, number, number

Returns:

Return Type	Description
number	The x-component of the anchor on Body 1.
number	The y-component of the anchor on Body 1.
number	The x-component of the anchor on Body 2.
number	The y-component of the anchor on Body 2.

getReactionForce

Type: Function.

Description:

  Returns the reaction force in newtons on the second body

Signature:

getReactionForce: function(self: Joint, inverse_delta_time: number): number, number

Parameters:

Parameter	Type	Description
inverse_delta_time	number	How long the force applies. Usually the inverse time step or 1/dt.

Returns:

Return Type	Description
number	The x-component of the force.
number	The y-component of the force.

getReactionTorque

Type: Function.

Description:

  Returns the reaction torque on the second body.

Signature:

getReactionTorque: function(self: Joint, inverse_delta_time: number): number

Parameters:

Parameter	Type	Description
inverse_delta_time	number	How long the force applies. Usually the inverse time step or 1/dt.

Returns:

Return Type	Description
number	The reaction torque on the second body.

getCollideConnected

Type: Function.

Description:

  Gets whether the connected Bodies collide.

Signature:

getCollideConnected: function(self: Joint): boolean

Returns:

Return Type	Description
boolean	True if they collide, false otherwise.

setUserData

Type: Function.

Description:

  Associates a Lua value with the Joint. To delete the reference, explicitly pass nil.

Signature:

setUserData: function(self: Joint, value: any)

Parameters:

Parameter	Type	Description
value	any	The Lua value to associate with the Joint.

getUserData

Type: Function.

Description:

  Returns the Lua value associated with this Joint.

Signature:

getUserData: function(self: Joint): any
	setLength: function(self: Joint, length: number)
	getLength: function(self: Joint): number
	setFrequency: function(self: Joint, frequency: number)
	getFrequency: function(self: Joint): number
	setDampingRatio: function(self: Joint, ratio: number)
	getDampingRatio: function(self: Joint): number
	getJointAngle: function(self: Joint): number
	getJointSpeed: function(self: Joint): number
	setMotorEnabled: function(self: Joint, enabled: boolean)
	isMotorEnabled: function(self: Joint): boolean
	setMaxMotorTorque: function(self: Joint, torque: number)
	getMaxMotorTorque: function(self: Joint): number
	setMotorSpeed: function(self: Joint, speed: number)
	getMotorSpeed: function(self: Joint): number
	getMotorTorque: function(self: Joint, inverse_delta_time: number): number
	setLimitsEnabled: function(self: Joint, enabled: boolean)
	areLimitsEnabled: function(self: Joint): boolean
	hasLimitsEnabled: function(self: Joint): boolean
	setUpperLimit: function(self: Joint, upper: number)
	setLowerLimit: function(self: Joint, lower: number)
	setLimits: function(self: Joint, lower: number, upper: number)
	getUpperLimit: function(self: Joint): number
	getLowerLimit: function(self: Joint): number
	getLimits: function(self: Joint): number, number
	getReferenceAngle: function(self: Joint): number
	getJointTranslation: function(self: Joint): number
	setMaxMotorForce: function(self: Joint, force: number)
	getMaxMotorForce: function(self: Joint): number
	getMotorForce: function(self: Joint, inverse_delta_time: number): number
	getAxis: function(self: Joint): number, number
	setMaxForce: function(self: Joint, force: number)
	getMaxForce: function(self: Joint): number
	setMaxTorque: function(self: Joint, torque: number)
	getMaxTorque: function(self: Joint): number
	setMaxLength: function(self: Joint, length: number)
	getMaxLength: function(self: Joint): number
	getGroundAnchors: function(self: Joint): number, number, number, number
	getLengthA: function(self: Joint): number
	getLengthB: function(self: Joint): number
	getRatio: function(self: Joint): number
	setSpringFrequency: function(self: Joint, frequency: number)
	getSpringFrequency: function(self: Joint): number
	setSpringDampingRatio: function(self: Joint, ratio: number)
	getSpringDampingRatio: function(self: Joint): number
	setTarget: function(self: Joint, x: number, y: number)
	getTarget: function(self: Joint): number, number
	setLinearOffset: function(self: Joint, x: number, y: number)
	getLinearOffset: function(self: Joint): number, number
	setAngularOffset: function(self: Joint, angle: number)
	getAngularOffset: function(self: Joint): number
	setCorrectionFactor: function(self: Joint, factor: number)
	getCorrectionFactor: function(self: Joint): number
	setRatio: function(self: Joint, ratio: number)
	getJoints: function(self: Joint): Joint, Joint

Parameters:

Parameter	Type	Description
length	number	The length parameter.
frequency	number	The frequency parameter.
ratio	number	The ratio parameter.
enabled	boolean	The enabled parameter.
torque	number	The torque parameter.
speed	number	The speed parameter.
inverse_delta_time	number	The inverse_delta_time parameter.
upper	number	The upper parameter.
lower	number	The lower parameter.
force	number	The force parameter.
x	number	The x parameter.
y	number	The y parameter.
angle	number	The angle parameter.
factor	number	The factor parameter.

Returns:

Return Type	Description
any or number or boolean or Joint	The Lua value associated with the Joint.