| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/modules/csg/doc_classes/CSGBox3D.xml.
- .. _class_CSGBox3D:
- CSGBox3D
- ========
- **Inherits:** :ref:`CSGPrimitive3D<class_CSGPrimitive3D>` **<** :ref:`CSGShape3D<class_CSGShape3D>` **<** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- A CSG Box shape.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- This node allows you to create a box for use with the CSG system.
- \ **Note:** CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a :ref:`MeshInstance3D<class_MeshInstance3D>` with a :ref:`PrimitiveMesh<class_PrimitiveMesh>`. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Prototyping levels with CSG <../tutorials/3d/csg_tools>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +---------------------------------+---------------------------------------------------+----------------------+
- | :ref:`Material<class_Material>` | :ref:`material<class_CSGBox3D_property_material>` | |
- +---------------------------------+---------------------------------------------------+----------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`size<class_CSGBox3D_property_size>` | ``Vector3(1, 1, 1)`` |
- +---------------------------------+---------------------------------------------------+----------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_CSGBox3D_property_material:
- .. rst-class:: classref-property
- :ref:`Material<class_Material>` **material** :ref:`🔗<class_CSGBox3D_property_material>`
- .. rst-class:: classref-property-setget
- - |void| **set_material**\ (\ value\: :ref:`Material<class_Material>`\ )
- - :ref:`Material<class_Material>` **get_material**\ (\ )
- The material used to render the box.
- .. rst-class:: classref-item-separator
- ----
- .. _class_CSGBox3D_property_size:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗<class_CSGBox3D_property_size>`
- .. rst-class:: classref-property-setget
- - |void| **set_size**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_size**\ (\ )
- The box's width, height and depth.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|
