Difference between revisions of "love.physics.newDistanceJoint"
(add new func, explanation based on source & Box2D docs) |
(Added warning to not call during callbacks) |
||
| (12 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | 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. | ||
| + | |||
| + | [[File:physicsJointDistance.PNG]] | ||
| + | |||
| + | {{notice|Making changes to a [[World]] is not allowed inside of the [[beginContact]], [[endContact]], [[preSolve]], and [[postSolve]] callback functions, as BOX2D locks the world during these callbacks.}} | ||
| + | |||
== Function == | == Function == | ||
| + | {{newin|[[0.8.0]]|080|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | joint = love.physics.newDistanceJoint( body1, body2, x1, y1, x2, y2, collideConnected ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|Body|body1|The first body to attach to the joint.}} | ||
| + | {{param|Body|body2|The second body to attach to the joint.}} | ||
| + | {{param|number|x1|The x position of the first anchor point (world space).}} | ||
| + | {{param|number|y1|The y position of the first anchor point (world space).}} | ||
| + | {{param|number|x2|The x position of the second anchor point (world space).}} | ||
| + | {{param|number|y2|The y position of the second anchor point (world space).}} | ||
| + | {{param|boolean|collideConnected (false)|Specifies whether the two bodies should collide with each other.}} | ||
| + | === Returns === | ||
| + | {{param|DistanceJoint|joint|The new distance joint.}} | ||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.8.0]]|080|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 8: | Line 31: | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param| | + | {{param|Body|body1|The first body to attach to the joint.}} |
| − | {{param| | + | {{param|Body|body2|The second body to attach to the joint.}} |
| − | {{param|number|x1|The x position of the first anchor point.}} | + | {{param|number|x1|The x position of the first anchor point (world space).}} |
| − | {{param|number|y1|The y position of the first anchor point.}} | + | {{param|number|y1|The y position of the first anchor point (world space).}} |
| − | {{param|number|x2|The x position of the second anchor point.}} | + | {{param|number|x2|The x position of the second anchor point (world space).}} |
| − | {{param|number|y2|The y position of the second anchor point.}} | + | {{param|number|y2|The y position of the second anchor point (world space).}} |
| − | |||
=== Returns === | === Returns === | ||
| − | {{param| | + | {{param|DistanceJoint|joint|The new distance joint.}} |
== See Also == | == See Also == | ||
* [[parent::love.physics]] | * [[parent::love.physics]] | ||
| + | * [[Constructs::DistanceJoint]] | ||
| + | * [[Constructs::Joint]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description= | + | {{#set:Description=Creates a [[DistanceJoint]] between two bodies.}} |
| − | }} | + | {{#set:Since=000}} |
| + | == Other Languages == | ||
| + | {{i18n|love.physics.newDistanceJoint}} | ||
Latest revision as of 07:50, 14 October 2018
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.
|
Making changes to a World is not allowed inside of the beginContact, endContact, preSolve, and postSolve callback functions, as BOX2D locks the world during these callbacks. |
Contents
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 (world space).
number y1- The y position of the first anchor point (world space).
number x2- The x position of the second anchor point (world space).
number y2- The y position of the second anchor point (world space).
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 (world space).
number y1- The y position of the first anchor point (world space).
number x2- The x position of the second anchor point (world space).
number y2- The y position of the second anchor point (world space).
Returns
DistanceJoint joint- The new distance joint.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
