Difference between revisions of "love.physics.newDistanceJoint"

(Adding Constructs::Joint for consistency with Shapes.)
Line 1: Line 1:
Creates a distance joint between two bodies.
+
Creates a [[DistanceJoint]] between two bodies.
  
 
This joint constrains the distance between two points on two bodies to be constant. These two points are specified in world coordinates and the two bodies are assumed to be in place when this joint is created. The first anchor point is connected to the first body and the second to the second body, and the points define the length of the distance joint.
 
This joint constrains the distance between two points on two bodies to be constant. These two points are specified in world coordinates and the two bodies are assumed to be in place when this joint is created. The first anchor point is connected to the first body and the second to the second body, and the points define the length of the distance joint.
Line 17: Line 17:
 
{{param|boolean|collideConnected (false)|Specifies whether the two bodies should collide with each other.}}
 
{{param|boolean|collideConnected (false)|Specifies whether the two bodies should collide with each other.}}
 
=== Returns ===
 
=== Returns ===
{{param|Joint|joint|The new distance joint.}}
+
{{param|DistanceJoint|joint|The new distance joint.}}
  
 
== Function ==
 
== Function ==
Line 33: Line 33:
 
{{param|number|y2|The y position of the second anchor point.}}
 
{{param|number|y2|The y position of the second anchor point.}}
 
=== Returns ===
 
=== Returns ===
{{param|Joint|joint|The new distance joint.}}
+
{{param|DistanceJoint|joint|The new distance joint.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.physics]]
 
* [[parent::love.physics]]
Line 39: Line 39:
 
* [[Constructs::Joint]]
 
* [[Constructs::Joint]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Creates a distance joint between two bodies.}}
+
{{#set:Description=Creates a [[DistanceJoint]] between two bodies.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.physics.newDistanceJoint}}
 
{{i18n|love.physics.newDistanceJoint}}

Revision as of 12:29, 28 July 2013

Creates a DistanceJoint between two bodies.

This joint constrains the distance between two points on two bodies to be constant. These two points are specified in world coordinates and the two bodies are assumed to be in place when this joint is created. The first anchor point is connected to the first body and the second to the second body, and the points define the length of the distance joint.

Function

Available since LÖVE 0.8.0
This variant is not supported in earlier versions.

Synopsis

joint = love.physics.newDistanceJoint( body1, body2, x1, y1, x2, y2, collideConnected )

Arguments

Body body1
The first body to attach to the joint.
Body body2
The second body to attach to the joint.
number x1
The x position of the first anchor point.
number y1
The y position of the first anchor point.
number x2
The x position of the second anchor point.
number y2
The y position of the second anchor point.
boolean collideConnected (false)
Specifies whether the two bodies should collide with each other.

Returns

DistanceJoint joint
The new distance joint.

Function

Removed in LÖVE 0.8.0
This variant is not supported in that and later versions.

Synopsis

joint = love.physics.newDistanceJoint( body1, body2, x1, y1, x2, y2 )

Arguments

Body body1
The first body to attach to the joint.
Body body2
The second body to attach to the joint.
number x1
The x position of the first anchor point.
number y1
The y position of the first anchor point.
number x2
The x position of the second anchor point.
number y2
The y position of the second anchor point.

Returns

DistanceJoint joint
The new distance joint.

See Also


Other Languages