diff options
| author | clayjohn <claynjohn@gmail.com> | 2020-01-22 22:12:52 -0800 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-23 13:54:17 +0100 |
| commit | 6b66957b857219d0ac6693a0266afed396d39091 (patch) | |
| tree | 8139dd19b38c43fb22a4d9443138ed48e5160718 /modules/csg/doc_classes | |
| parent | e7e8318546cef3aa482d71c5b0ddd5a664e241eb (diff) | |
Finish documenting CSG* and *probes
Diffstat (limited to 'modules/csg/doc_classes')
| -rw-r--r-- | modules/csg/doc_classes/CSGMesh.xml | 3 | ||||
| -rw-r--r-- | modules/csg/doc_classes/CSGPrimitive.xml | 1 | ||||
| -rw-r--r-- | modules/csg/doc_classes/CSGShape.xml | 2 |
3 files changed, 5 insertions, 1 deletions
diff --git a/modules/csg/doc_classes/CSGMesh.xml b/modules/csg/doc_classes/CSGMesh.xml index afe0bc262d..aae730aa49 100644 --- a/modules/csg/doc_classes/CSGMesh.xml +++ b/modules/csg/doc_classes/CSGMesh.xml @@ -12,9 +12,10 @@ </methods> <members> <member name="material" type="Material" setter="set_material" getter="get_material"> + The [Material] used in drawing the CSG shape. </member> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> - The mesh resource to use as a CSG shape. + The [Mesh] resource to use as a CSG shape. </member> </members> <constants> diff --git a/modules/csg/doc_classes/CSGPrimitive.xml b/modules/csg/doc_classes/CSGPrimitive.xml index 6c2f837637..0a692ffbdb 100644 --- a/modules/csg/doc_classes/CSGPrimitive.xml +++ b/modules/csg/doc_classes/CSGPrimitive.xml @@ -4,6 +4,7 @@ Base class for CSG primitives. </brief_description> <description> + Parent class for various CSG primitives. It contains code and functionality that is common between them. It cannot be used directly. Instead use one of the various classes that inherit from it. </description> <tutorials> </tutorials> diff --git a/modules/csg/doc_classes/CSGShape.xml b/modules/csg/doc_classes/CSGShape.xml index 755d8df67e..9566c04f19 100644 --- a/modules/csg/doc_classes/CSGShape.xml +++ b/modules/csg/doc_classes/CSGShape.xml @@ -31,6 +31,7 @@ <return type="Array"> </return> <description> + Returns an [Array] with two elements, the first is the [Transform] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. </description> </method> <method name="is_root_shape" qualifiers="const"> @@ -79,6 +80,7 @@ The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. </member> <member name="snap" type="float" setter="set_snap" getter="get_snap" default="0.001"> + Snap makes the mesh snap to a given distance so that the faces of two meshes can be perfectly aligned. A lower value results in greater precision but may be harder to adjust. </member> <member name="use_collision" type="bool" setter="set_use_collision" getter="is_using_collision" default="false"> Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. |