class_csgbox3d.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CSGBox3D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CSGBox3D:
  6. CSGBox3D
  7. ========
  8. **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>`
  9. A CSG Box shape.
  10. Description
  11. -----------
  12. This node allows you to create a box for use with the CSG system.
  13. Properties
  14. ----------
  15. +---------------------------------+---------------------------------------------------+----------------------+
  16. | :ref:`Material<class_Material>` | :ref:`material<class_CSGBox3D_property_material>` | |
  17. +---------------------------------+---------------------------------------------------+----------------------+
  18. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_CSGBox3D_property_size>` | ``Vector3(2, 2, 2)`` |
  19. +---------------------------------+---------------------------------------------------+----------------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CSGBox3D_property_material:
  23. - :ref:`Material<class_Material>` **material**
  24. +----------+---------------------+
  25. | *Setter* | set_material(value) |
  26. +----------+---------------------+
  27. | *Getter* | get_material() |
  28. +----------+---------------------+
  29. The material used to render the box.
  30. ----
  31. .. _class_CSGBox3D_property_size:
  32. - :ref:`Vector3<class_Vector3>` **size**
  33. +-----------+----------------------+
  34. | *Default* | ``Vector3(2, 2, 2)`` |
  35. +-----------+----------------------+
  36. | *Setter* | set_size(value) |
  37. +-----------+----------------------+
  38. | *Getter* | get_size() |
  39. +-----------+----------------------+
  40. The box's width, height and depth.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`