7adf4cc9b5
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.
40 lines
1.9 KiB
XML
40 lines
1.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CollisionShape3D" inherits="Node3D" version="4.0">
|
|
<brief_description>
|
|
Node that represents collision shape data in 3D space.
|
|
</brief_description>
|
|
<description>
|
|
Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area3D] to give it a detection shape, or add it to a [PhysicsBody3D] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject3D.shape_owner_get_shape] to get the actual shape.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link>
|
|
<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>
|
|
<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
|
|
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="make_convex_from_siblings">
|
|
<return type="void" />
|
|
<description>
|
|
Sets the collision shape's shape to the addition of all its convexed [MeshInstance3D] siblings geometry.
|
|
</description>
|
|
</method>
|
|
<method name="resource_changed">
|
|
<return type="void" />
|
|
<argument index="0" name="resource" type="Resource" />
|
|
<description>
|
|
If this method exists within a script it will be called whenever the shape resource has been modified.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
|
|
A disabled collision shape has no effect in the world.
|
|
</member>
|
|
<member name="shape" type="Shape3D" setter="set_shape" getter="get_shape">
|
|
The actual shape owned by this collision shape.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|