2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "CollisionPolygon2D" inherits= "Node2D" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-10-02 12:13:36 +08:00
Defines a 2D collision polygon.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-12-07 06:09:20 +08:00
Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygons can be drawn in the editor or specified by a list of vertices.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "build_mode" type= "int" setter= "set_build_mode" getter= "get_build_mode" enum= "CollisionPolygon2D.BuildMode" default= "0" >
2019-12-07 06:09:20 +08:00
Collision build mode. Use one of the [enum BuildMode] constants.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "disabled" type= "bool" setter= "set_disabled" getter= "is_disabled" default= "false" >
2018-12-20 20:46:54 +08:00
If [code]true[/code], no collisions will be detected.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "one_way_collision" type= "bool" setter= "set_one_way_collision" getter= "is_one_way_collision_enabled" default= "false" >
2019-12-07 06:09:20 +08:00
If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "one_way_collision_margin" type= "float" setter= "set_one_way_collision_margin" getter= "get_one_way_collision_margin" default= "1.0" >
2020-03-04 02:21:21 +08:00
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
2019-01-27 05:21:53 +08:00
</member>
2020-02-18 20:59:24 +08:00
<member name= "polygon" type= "PackedVector2Array" setter= "set_polygon" getter= "get_polygon" default= "PackedVector2Array( )" >
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "BUILD_SOLIDS" value= "0" enum= "BuildMode" >
2017-10-02 12:13:36 +08:00
Collisions will include the polygon and its contained area.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "BUILD_SEGMENTS" value= "1" enum= "BuildMode" >
2017-10-02 12:13:36 +08:00
Collisions will only include the polygon edges.
2017-09-16 07:46:14 +08:00
</constant>
2017-09-13 04:42:36 +08:00
</constants>
</class>