Files
godot-docs/classes/class_boxshape.rst
T
Rémi Verschelde 1204e3ea17 Add a warning header to each classref file
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
2016-02-17 22:04:18 +01:00

48 lines
1.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------+
Description
-----------
Box shape resource, which can be set into a :ref:`PhysicsBody<class_physicsbody>` or area.
Member Function Description
---------------------------
.. _class_BoxShape_set_extents:
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
Set the half extents for the shape.
.. _class_BoxShape_get_extents:
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
Return the half extents of the shape.