:github_url: hide

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

.. _class_World2D:

World2D
=======

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Class that has everything pertaining to a 2D world.

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.

Tutorials
---------

- :doc:`Ray-casting <../tutorials/physics/ray-casting>`

Properties
----------

+-------------------------------------------------------------------+----------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`canvas<class_World2D_property_canvas>`                         |
+-------------------------------------------------------------------+----------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` | :ref:`direct_space_state<class_World2D_property_direct_space_state>` |
+-------------------------------------------------------------------+----------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`navigation_map<class_World2D_property_navigation_map>`         |
+-------------------------------------------------------------------+----------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`space<class_World2D_property_space>`                           |
+-------------------------------------------------------------------+----------------------------------------------------------------------+

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

.. _class_World2D_property_canvas:

- :ref:`RID<class_RID>` **canvas**

+----------+--------------+
| *Getter* | get_canvas() |
+----------+--------------+

The :ref:`RID<class_RID>` of this world's canvas resource. Used by the :ref:`RenderingServer<class_RenderingServer>` for 2D drawing.

----

.. _class_World2D_property_direct_space_state:

- :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **direct_space_state**

+----------+--------------------------+
| *Getter* | get_direct_space_state() |
+----------+--------------------------+

Direct access to the world's physics 2D space state. Used for querying current and potential collisions. When using multi-threaded physics, access is limited to ``_physics_process(delta)`` in the main thread.

----

.. _class_World2D_property_navigation_map:

- :ref:`RID<class_RID>` **navigation_map**

+----------+----------------------+
| *Getter* | get_navigation_map() |
+----------+----------------------+

The :ref:`RID<class_RID>` of this world's navigation map. Used by the :ref:`NavigationServer2D<class_NavigationServer2D>`.

----

.. _class_World2D_property_space:

- :ref:`RID<class_RID>` **space**

+----------+-------------+
| *Getter* | get_space() |
+----------+-------------+

The :ref:`RID<class_RID>` of this world's physics space resource. Used by the :ref:`PhysicsServer2D<class_PhysicsServer2D>` for 2D physics, treating it as both a space and an area.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`