| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 |
- :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>`
- A resource that holds all components of a 2D world, such as a canvas and a physics space.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- Class that has everything pertaining to a 2D world: A physics space, a canvas, and a sound space. 2D nodes register their resources into the current 2D world.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Ray-casting <../tutorials/physics/ray-casting>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-------------------------------------------------------------------+----------------------------------------------------------------------+
- | :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>` |
- +-------------------------------------------------------------------+----------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_World2D_property_canvas:
- .. rst-class:: classref-property
- :ref:`RID<class_RID>` **canvas**
- .. rst-class:: classref-property-setget
- - :ref:`RID<class_RID>` **get_canvas** **(** **)**
- The :ref:`RID<class_RID>` of this world's canvas resource. Used by the :ref:`RenderingServer<class_RenderingServer>` for 2D drawing.
- .. rst-class:: classref-item-separator
- ----
- .. _class_World2D_property_direct_space_state:
- .. rst-class:: classref-property
- :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **direct_space_state**
- .. rst-class:: classref-property-setget
- - :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` **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 :ref:`Node._physics_process<class_Node_private_method__physics_process>` in the main thread.
- .. rst-class:: classref-item-separator
- ----
- .. _class_World2D_property_navigation_map:
- .. rst-class:: classref-property
- :ref:`RID<class_RID>` **navigation_map**
- .. rst-class:: classref-property-setget
- - :ref:`RID<class_RID>` **get_navigation_map** **(** **)**
- The :ref:`RID<class_RID>` of this world's navigation map. Used by the :ref:`NavigationServer2D<class_NavigationServer2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_World2D_property_space:
- .. rst-class:: classref-property
- :ref:`RID<class_RID>` **space**
- .. rst-class:: classref-property-setget
- - :ref:`RID<class_RID>` **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.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
