diff options
Diffstat (limited to 'doc/classes/CollisionPolygon3D.xml')
| -rw-r--r-- | doc/classes/CollisionPolygon3D.xml | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml new file mode 100644 index 0000000000..dd3c57d1d0 --- /dev/null +++ b/doc/classes/CollisionPolygon3D.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionPolygon3D" inherits="Node3D" version="4.0"> + <brief_description> + Editor-only class for defining a collision polygon in 3D space. + </brief_description> + <description> + 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 run-time. Creates a [Shape3D] for gameplay. Properties modified during gameplay will have no effect. + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0"> + Length that the resulting collision extends in either direction perpendicular to its polygon. + </member> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false"> + If [code]true[/code], no collision will be produced. + </member> + <member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array( )"> + Array of vertices which define the polygon. + [b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member. + </member> + </members> + <constants> + </constants> +</class> |