class_world2d.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the World2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_World2D:
  5. World2D
  6. =======
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Class that has everything pertaining to a 2D world.
  12. Member Variables
  13. ----------------
  14. .. _class_World2D_canvas:
  15. - :ref:`RID<class_rid>` **canvas** - The :ref:`RID<class_rid>` of this world's canvas resource. Used by the :ref:`VisualServer<class_visualserver>` for 2D drawing.
  16. .. _class_World2D_direct_space_state:
  17. - :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` **direct_space_state** - The state of this world's physics space. This allows arbitrary querying for collision.
  18. .. _class_World2D_space:
  19. - :ref:`RID<class_rid>` **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.
  20. Description
  21. -----------
  22. 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.