Files
godot-docs/classes/class_csgbox.rst
2019-01-07 10:14:12 +01:00

88 lines
2.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGBox.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CSGBox:
CSGBox
======
**Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
A CSG Box shape.
Properties
----------
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`depth<class_CSGBox_property_depth>` |
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`height<class_CSGBox_property_height>` |
+---------------------------------+-------------------------------------------------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGBox_property_material>` |
+---------------------------------+-------------------------------------------------+
| :ref:`float<class_float>` | :ref:`width<class_CSGBox_property_width>` |
+---------------------------------+-------------------------------------------------+
Description
-----------
This node allows you to create a box for use with the CSG system.
Property Descriptions
---------------------
.. _class_CSGBox_property_depth:
- :ref:`float<class_float>` **depth**
+----------+------------------+
| *Setter* | set_depth(value) |
+----------+------------------+
| *Getter* | get_depth() |
+----------+------------------+
Depth of the box measured from the center of the box.
.. _class_CSGBox_property_height:
- :ref:`float<class_float>` **height**
+----------+-------------------+
| *Setter* | set_height(value) |
+----------+-------------------+
| *Getter* | get_height() |
+----------+-------------------+
Height of the box measured from the center of the box.
.. _class_CSGBox_property_material:
- :ref:`Material<class_Material>` **material**
+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material() |
+----------+---------------------+
The material used to render the box.
.. _class_CSGBox_property_width:
- :ref:`float<class_float>` **width**
+----------+------------------+
| *Setter* | set_width(value) |
+----------+------------------+
| *Getter* | get_width() |
+----------+------------------+
Width of the box measured from the center of the box.