class_boxshape.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the BoxShape.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_BoxShape:
  5. BoxShape
  6. ========
  7. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Box shape resource.
  12. Properties
  13. ----------
  14. +-------------------------------+-------------------------------------------------+--------------------+
  15. | :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | Vector3( 1, 1, 1 ) |
  16. +-------------------------------+-------------------------------------------------+--------------------+
  17. Description
  18. -----------
  19. 3D box shape that can be a child of a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_BoxShape_property_extents:
  23. - :ref:`Vector3<class_Vector3>` **extents**
  24. +-----------+--------------------+
  25. | *Default* | Vector3( 1, 1, 1 ) |
  26. +-----------+--------------------+
  27. | *Setter* | set_extents(value) |
  28. +-----------+--------------------+
  29. | *Getter* | get_extents() |
  30. +-----------+--------------------+
  31. The box's half extents. The width, height and depth of this shape is twice the half extents.