mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
72 lines
2.6 KiB
ReStructuredText
72 lines
2.6 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the World2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------------------------------------+-------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`canvas<class_World2D_canvas>` |
|
|
+-------------------------------------------------------------------+-------------------------------------------------------------+
|
|
| :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` | :ref:`direct_space_state<class_World2D_direct_space_state>` |
|
|
+-------------------------------------------------------------------+-------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`space<class_World2D_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.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/physics/ray-casting`
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_World2D_canvas:
|
|
|
|
- :ref:`RID<class_RID>` **canvas**
|
|
|
|
+----------+--------------+
|
|
| *Getter* | get_canvas() |
|
|
+----------+--------------+
|
|
|
|
The :ref:`RID<class_RID>` of this world's canvas resource. Used by the :ref:`VisualServer<class_VisualServer>` for 2D drawing.
|
|
|
|
.. _class_World2D_direct_space_state:
|
|
|
|
- :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>` **direct_space_state**
|
|
|
|
+----------+--------------------------+
|
|
| *Getter* | get_direct_space_state() |
|
|
+----------+--------------------------+
|
|
|
|
The state of this world's physics space. This allows arbitrary querying for collision.
|
|
|
|
.. _class_World2D_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:`Physics2DServer<class_Physics2DServer>` for 2D physics, treating it as both a space and an area.
|
|
|