.. 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_World2D:

World2D
=======

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Class that has everything pertaining to a 2D world.

Member Functions
----------------

+--------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :ref:`RID<class_rid>`                                              | :ref:`get_canvas<class_World2D_get_canvas>`  **(** **)**                         |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`  | :ref:`get_direct_space_state<class_World2D_get_direct_space_state>`  **(** **)** |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :ref:`RID<class_rid>`                                              | :ref:`get_sound_space<class_World2D_get_sound_space>`  **(** **)**               |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :ref:`RID<class_rid>`                                              | :ref:`get_space<class_World2D_get_space>`  **(** **)**                           |
+--------------------------------------------------------------------+----------------------------------------------------------------------------------+

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

Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world.

Member Function Description
---------------------------

.. _class_World2D_get_canvas:

- :ref:`RID<class_rid>`  **get_canvas**  **(** **)**

Retrieve the :ref:`RID<class_rid>` of this world's canvas resource. Used by the :ref:`VisualServer<class_visualserver>` for 2D drawing.

.. _class_World2D_get_direct_space_state:

- :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>`  **get_direct_space_state**  **(** **)**

Retrieve the state of this world's physics space. This allows arbitrary querying for collision.

.. _class_World2D_get_sound_space:

- :ref:`RID<class_rid>`  **get_sound_space**  **(** **)**

Retrieve the :ref:`RID<class_rid>` of this world's sound space resource. Used by the :ref:`SpatialSound2DServer<class_spatialsound2dserver>` for 2D spatial audio.

.. _class_World2D_get_space:

- :ref:`RID<class_rid>`  **get_space**  **(** **)**

Retrieve the :ref:`RID<class_rid>` of this world's physics space resource. Used by the :ref:`Physics2DServer<class_physics2dserver>` for 2D physics, treating it as both a space and an area.


