From 60a929d18e942a08457d29c7f958fbf2acffb02d Mon Sep 17 00:00:00 2001 From: FigyTuna Date: Fri, 15 Sep 2017 18:12:44 -0700 Subject: Modified the descriptions for CollisionPolygon2D and created descriptions for CollisionPolygon --- doc/classes/CollisionPolygon.xml | 5 +++++ doc/classes/CollisionPolygon2D.xml | 8 ++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml index cf425e3d60..c2496424d6 100644 --- a/doc/classes/CollisionPolygon.xml +++ b/doc/classes/CollisionPolygon.xml @@ -1,8 +1,10 @@ + Editor-only class for defining a collision polygon in 3D space. + Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect. @@ -54,10 +56,13 @@ + Length that the resulting collision extends in either direction perpendicular to its polygon. + If true, no collision will be produced. + Array of vertices which define the polygon. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index b602610167..d3dee1e9bb 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -1,10 +1,10 @@ - Editor-only class for easy editing of collision polygons. + Editor-only class for defining a collision polygon in 2D space. - Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons. + 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. @@ -75,12 +75,16 @@ + 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. + If true, no collision will be produced. + If true, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. + Array of vertices which define the polygon. -- cgit v1.2.3