Difference between revisions of "love.physics.newPolygonShape"

 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Creates a new PolygonShape.
+
Creates a new [[PolygonShape]].
  
 
This shape can have 8 vertices at most, and must form a convex shape.
 
This shape can have 8 vertices at most, and must form a convex shape.
  
 
== Function ==
 
== Function ==
 +
{{newin|[[0.8.0]]|080|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
shape = love.physics.newPolygonShape( x1, y1, x2, y2, x3, y3, ... )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|x1|The x position of the first point, relative to the body it is attached to.}}
 +
{{param|number|y1|The y position of the first point, relative to the body it is attached to.}}
 +
{{param|number|x2|The x position of the second point, relative to the body it is attached to.}}
 +
{{param|number|y2|The y position of the second point, relative to the body it is attached to.}}
 +
{{param|number|x3|The x position of the third point, relative to the body it is attached to.}}
 +
{{param|number|y3|The y position of the third point, relative to the body it is attached to.}}
 +
{{param|number|...|You can continue passing more point positions to create the PolygonShape.}}
 +
 +
=== Returns ===
 +
{{param|PolygonShape|shape|A new PolygonShape.}}
 +
 +
== Function ==
 +
{{newin|[[0.9.2]]|092|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
shape = love.physics.newPolygonShape( vertices )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|vertices|A list of vertices to construct the polygon, in the form of <code>{x1, y1, x2, y2, x3, y3, ...}</code>.}}
 +
 +
=== Returns ===
 +
{{param|PolygonShape|shape|A new PolygonShape.}}
 +
 +
== Function ==
 +
{{oldin|[[0.8.0]]|080|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 13: Line 44:
 
=== Returns ===
 
=== Returns ===
 
{{param|PolygonShape|shape|A new PolygonShape.}}
 
{{param|PolygonShape|shape|A new PolygonShape.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.physics]]
 
* [[parent::love.physics]]
 
* [[Constructs::PolygonShape]]
 
* [[Constructs::PolygonShape]]
 +
* [[Constructs::Shape]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Creates a new PolygonShape.}}
+
{{#set:Description=Creates a new [[PolygonShape]].}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.physics.newPolygonShape}}
 
{{i18n|love.physics.newPolygonShape}}

Latest revision as of 09:55, 16 July 2022

Creates a new PolygonShape.

This shape can have 8 vertices at most, and must form a convex shape.

Function

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

Synopsis

shape = love.physics.newPolygonShape( x1, y1, x2, y2, x3, y3, ... )

Arguments

number x1
The x position of the first point, relative to the body it is attached to.
number y1
The y position of the first point, relative to the body it is attached to.
number x2
The x position of the second point, relative to the body it is attached to.
number y2
The y position of the second point, relative to the body it is attached to.
number x3
The x position of the third point, relative to the body it is attached to.
number y3
The y position of the third point, relative to the body it is attached to.
number ...
You can continue passing more point positions to create the PolygonShape.

Returns

PolygonShape shape
A new PolygonShape.

Function

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

Synopsis

shape = love.physics.newPolygonShape( vertices )

Arguments

table vertices
A list of vertices to construct the polygon, in the form of {x1, y1, x2, y2, x3, y3, ...}.

Returns

PolygonShape shape
A new PolygonShape.

Function

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

Synopsis

shape = love.physics.newPolygonShape( body, ... )

Arguments

Body body
The body to attach the shape to.
numbers ...
Vertices of the polygon.

Returns

PolygonShape shape
A new PolygonShape.

See Also


Other Languages