class_boxshape.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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. Member Functions
  13. ----------------
  14. +--------------------------------+----------------------------------------------------------------------------------------------------+
  15. | :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
  16. +--------------------------------+----------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
  18. +--------------------------------+----------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`Vector3<class_vector3>` **extents** - The shape's half extents.
  22. Description
  23. -----------
  24. 3D box shape that can be a child of a :ref:`PhysicsBody<class_physicsbody>` or :ref:`Area<class_area>`.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_BoxShape_get_extents:
  28. - :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
  29. Return the half extents of the shape.
  30. .. _class_BoxShape_set_extents:
  31. - void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
  32. Set the half extents for the shape.