godot-docs/classes/class_rectangleshape2d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RectangleShape2D.xml.

.. _class_RectangleShape2D:

RectangleShape2D
================

**Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Rectangle shape for 2D collisions.

.. rst-class:: classref-introduction-group

Description
-----------

Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects.

.. rst-class:: classref-introduction-group

Tutorials
---------

- `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`__

- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------------+---------------------------------------------------------+-----------------------+
   | :ref:`Vector2<class_Vector2>` | :ref:`extents<class_RectangleShape2D_property_extents>` | ``Vector2( 10, 10 )`` |
   +-------------------------------+---------------------------------------------------------+-----------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_RectangleShape2D_property_extents:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **extents** = ``Vector2( 10, 10 )``

.. rst-class:: classref-property-setget

- void **set_extents** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_extents** **(** **)**

The rectangle's half extents. The width and height 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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`