Files
godot-docs/classes/class_boxshape.rst
T
Rémi Verschelde 2b4319bc29 Sync classref with current source
Changes order of brief/long descriptions and removes category
as per godotengine/godot#35132.
2020-01-15 00:51:47 +01:00

45 lines
1.3 KiB
ReStructuredText

:github_url: hide
.. 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>`
Box shape resource.
Description
-----------
3D box shape that can be a child of a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`.
Properties
----------
+-------------------------------+-------------------------------------------------+--------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_BoxShape_property_extents>` | Vector3( 1, 1, 1 ) |
+-------------------------------+-------------------------------------------------+--------------------+
Property Descriptions
---------------------
.. _class_BoxShape_property_extents:
- :ref:`Vector3<class_Vector3>` **extents**
+-----------+--------------------+
| *Default* | Vector3( 1, 1, 1 ) |
+-----------+--------------------+
| *Setter* | set_extents(value) |
+-----------+--------------------+
| *Getter* | get_extents() |
+-----------+--------------------+
The box's half extents. The width, height and depth of this shape is twice the half extents.