mirror of
https://github.com/godotengine/godot
synced 2024-09-05 17:49:51 +00:00
0e6b796cf6
Using non-uniform scale is known to cause many issues. Add warnings to the editor and to the class reference. Also remove the warning from SoftBody3D since it is not relevant there: it simulates in global space.
29 lines
2.1 KiB
XML
29 lines
2.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CollisionPolygon3D" inherits="Node3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Editor-only node for defining a collision polygon in 3D space.
|
|
</brief_description>
|
|
<description>
|
|
Allows editing a concave or convex 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 several [ConvexPolygonShape3D]s at run-time to represent the original polygon using convex decomposition.
|
|
[b]Note:[/b] Since this is an editor-only helper, properties modified during gameplay will have no effect.
|
|
[b]Warning:[/b] A non-uniformly scaled CollisionPolygon3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change its [member polygon]'s vertices instead.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<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="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
|
|
The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.
|
|
</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>
|
|
</class>
|