Difference between revisions of "love.physics.newChainShape"

(Link to ChainShape in description.)
(Added warning to not call during callbacks)
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{newin|[[0.8.0]]|080|type=function}}
 
{{newin|[[0.8.0]]|080|type=function}}
 
Creates a new [[ChainShape]].
 
Creates a new [[ChainShape]].
 
+
{{notice|Due to a limitation of the current collision algorithm, collision with chain shapes can react in a odd manner.  see [[https://code.google.com/p/box2d/issues/detail?id=286 here]]}}
 +
{{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 ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 13: Line 14:
 
{{param|number|x2|The x position of the second point.}}
 
{{param|number|x2|The x position of the second point.}}
 
{{param|number|y2|The y position of the second point.}}
 
{{param|number|y2|The y position of the second point.}}
 +
{{param|number|...|Additional point positions.}}
 +
=== Returns ===
 +
{{param|ChainShape|shape|The new shape.}}
 +
 +
== Function ==
 +
{{newin|[[0.9.2]]|092|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
shape = love.physics.newChainShape( loop, points )
 +
</source>
 +
=== Arguments ===
 +
{{param|boolean|loop|If the chain should loop back to the first point.}}
 +
{{param|table|points|A list of points to construct the ChainShape, in the form of <code>{x1, y1, x2, y2, ...}</code>.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|ChainShape|shape|The new shape.}}
 
{{param|ChainShape|shape|The new shape.}}

Revision as of 07:48, 14 October 2018

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

Creates a new ChainShape.

O.png Due to a limitation of the current collision algorithm, collision with chain shapes can react in a odd manner. see [here]  


O.png 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

Synopsis

shape = love.physics.newChainShape( loop, x1, y1, x2, y2, ... )

Arguments

boolean loop
If the chain should loop back to the first point.
number x1
The x position of the first point.
number y1
The y position of the first point.
number x2
The x position of the second point.
number y2
The y position of the second point.
number ...
Additional point positions.

Returns

ChainShape shape
The new shape.

Function

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

Synopsis

shape = love.physics.newChainShape( loop, points )

Arguments

boolean loop
If the chain should loop back to the first point.
table points
A list of points to construct the ChainShape, in the form of {x1, y1, x2, y2, ...}.

Returns

ChainShape shape
The new shape.

See Also


Other Languages