diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-02-15 11:23:15 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-15 11:23:15 +0100 |
| commit | 3f6295a1ed91975dcbf7f5ba9e0bb36f525538a1 (patch) | |
| tree | 8259df71aa5df8bf354be2fc5caf9240764d33aa /doc/classes | |
| parent | d8691e8ce28fd6899a20bdf76623ee1471862bab (diff) | |
| parent | fbb1ef759cca66f44523760569f1fcc3f015e2cb (diff) | |
Merge pull request #45855 from hoontee/fix-45718
Implement CollisionPolygon3D margin
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/CollisionPolygon3D.xml | 3 | ||||
| -rw-r--r-- | doc/classes/Shape3D.xml | 3 |
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml index dd3c57d1d0..38f4c5fe5c 100644 --- a/doc/classes/CollisionPolygon3D.xml +++ b/doc/classes/CollisionPolygon3D.xml @@ -17,6 +17,9 @@ <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. diff --git a/doc/classes/Shape3D.xml b/doc/classes/Shape3D.xml index 2d8bb5d051..f3e62175c6 100644 --- a/doc/classes/Shape3D.xml +++ b/doc/classes/Shape3D.xml @@ -13,7 +13,8 @@ </methods> <members> <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04"> - The collision margin for the shape. + The collision margin for the shape. Used in Bullet Physics only. + Collision margins allows collision detection to be more efficient by adding an extra shell around shapes. Collision algorithms are more expensive when objects overlap by more than their margin, so a higher value for margins is better for performance, at the cost of accuracy around edges as it makes them less sharp. </member> </members> <constants> |