class_boxshape.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_BoxShape:
  4. BoxShape
  5. ========
  6. **Inherits:** :ref:`Shape<class_shape>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Box shape resource.
  11. Member Functions
  12. ----------------
  13. +--------------------------------+----------------------------------------------------------------------------------------------------+
  14. | :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
  15. +--------------------------------+----------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
  17. +--------------------------------+----------------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. Box shape resource, which can be set into a :ref:`PhysicsBody<class_physicsbody>` or area.
  21. Member Function Description
  22. ---------------------------
  23. .. _class_BoxShape_get_extents:
  24. - :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
  25. Return the half extents of the shape.
  26. .. _class_BoxShape_set_extents:
  27. - void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
  28. Set the half extents for the shape.