aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/CollisionPolygon2D.xml
diff options
context:
space:
mode:
authorChris Bradfield2017-10-01 21:13:36 -0700
committerChris Bradfield2017-10-02 09:36:09 -0700
commitee1afc8bcae2842ee50880d5150d56106d7099ca (patch)
tree8c758fe747ab5ccc9fdf9ac5c6809f1581f87d1b /doc/classes/CollisionPolygon2D.xml
parentc864b782c05f5e2833afd69a4c0dfc6fbcfc4b26 (diff)
downloadgodot-ee1afc8bcae2842ee50880d5150d56106d7099ca.tar.gz
godot-ee1afc8bcae2842ee50880d5150d56106d7099ca.tar.zst
godot-ee1afc8bcae2842ee50880d5150d56106d7099ca.zip
[DOCS] Update Polygon2D and CollisionPolygon2D
Diffstat (limited to 'doc/classes/CollisionPolygon2D.xml')
-rw-r--r--doc/classes/CollisionPolygon2D.xml14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml
index d3dee1e9b..7f30e8e83 100644
--- a/doc/classes/CollisionPolygon2D.xml
+++ b/doc/classes/CollisionPolygon2D.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
<brief_description>
- Editor-only class for defining a collision polygon in 2D space.
+ Defines a 2D collision polygon.
</brief_description>
<description>
- Allows editing a collision polygon's vertices. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape2D] for gameplay. Properties modified during gameplay will have no effect.
+ Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygon can be drawn in the editor or specified by a list of vertices.
</description>
<tutorials>
</tutorials>
@@ -75,22 +75,24 @@
</methods>
<members>
<member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode">
- If BUILD_SOLIDS, the polygon and the area within it will have collision. If BUILD_SEGMENTS, only the edges of the polygon will have collision.
+ Collision build mode. Use one of the [code]BUILD_*[/code] constants. Default value: [code]BUILD_SOLIDS[/code].
</member>
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
- If true, no collision will be produced.
+ If [code]true[/code] no collisions will be detected.
</member>
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled">
- If true, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
+ If [code]true[/code] only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
</member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
- Array of vertices which define the polygon.
+ The polygon's list of vertices. The final point will be connected to the first.
</member>
</members>
<constants>
<constant name="BUILD_SOLIDS" value="0">
+ Collisions will include the polygon and its contained area.
</constant>
<constant name="BUILD_SEGMENTS" value="1">
+ Collisions will only include the polygon edges.
</constant>
</constants>
</class>