Files
godot-docs/classes/class_boxshape.rst
T

54 lines
1.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the BoxShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_BoxShape:
BoxShape
========
**Inherits:** :ref:`Shape<class_shape>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Box shape resource.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector3<class_vector3>` **extents** - The shape's half extents.
Description
-----------
3D box shape that can be a child of a :ref:`PhysicsBody<class_physicsbody>` or :ref:`Area<class_area>`.
Member Function Description
---------------------------
.. _class_BoxShape_get_extents:
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
Return the half extents of the shape.
.. _class_BoxShape_set_extents:
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
Set the half extents for the shape.