class_boxshape.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the BoxShape.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_BoxShape:
  6. BoxShape
  7. ========
  8. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Box shape resource.
  10. Description
  11. -----------
  12. 3D box shape that can be a child of a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`.
  13. Properties
  14. ----------
  15. +-------------------------------+-------------------------------------------------+------------------------+
  16. | :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | ``Vector3( 1, 1, 1 )`` |
  17. +-------------------------------+-------------------------------------------------+------------------------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_BoxShape_property_extents:
  21. - :ref:`Vector3<class_Vector3>` **extents**
  22. +-----------+------------------------+
  23. | *Default* | ``Vector3( 1, 1, 1 )`` |
  24. +-----------+------------------------+
  25. | *Setter* | set_extents(value) |
  26. +-----------+------------------------+
  27. | *Getter* | get_extents() |
  28. +-----------+------------------------+
  29. The box's half extents. The width, height and depth of this shape is twice the half extents.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`