f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
28 lines
1.4 KiB
XML
28 lines
1.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.2">
|
|
<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 [Shape] 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">
|
|
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">
|
|
If [code]true[/code], no collision will be produced.
|
|
</member>
|
|
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
|
|
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>
|