pandemonium_engine_docs/classes/class_boxshape.rst

57 lines
2.0 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.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>`.
Tutorials
---------
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`__
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__
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.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`