16fd1c421e
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
29 lines
1.2 KiB
XML
29 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Shape" inherits="Resource" version="3.3">
|
|
<brief_description>
|
|
Base class for all 3D shape resources.
|
|
</brief_description>
|
|
<description>
|
|
Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a [PhysicsBody] or [Area] objects.
|
|
</description>
|
|
<tutorials>
|
|
<link>https://docs.godotengine.org/en/3.3/tutorials/physics/physics_introduction.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_debug_mesh">
|
|
<return type="ArrayMesh" />
|
|
<description>
|
|
Returns the [ArrayMesh] used to draw the debug collision for this [Shape].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
|
|
The collision margin for the shape. Used in Bullet Physics only.
|
|
Collision margins allow 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>
|
|
</constants>
|
|
</class>
|