class_world.rst 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the World.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_World:
  5. World
  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 world.
  12. Member Functions
  13. ----------------
  14. +----------------------------------------------------------------+-------------------------------------------------------------------------------+
  15. | :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`get_direct_space_state<class_World_get_direct_space_state>` **(** **)** |
  16. +----------------------------------------------------------------+-------------------------------------------------------------------------------+
  17. | :ref:`RID<class_rid>` | :ref:`get_scenario<class_World_get_scenario>` **(** **)** const |
  18. +----------------------------------------------------------------+-------------------------------------------------------------------------------+
  19. | :ref:`RID<class_rid>` | :ref:`get_space<class_World_get_space>` **(** **)** const |
  20. +----------------------------------------------------------------+-------------------------------------------------------------------------------+
  21. Member Variables
  22. ----------------
  23. .. _class_World_environment:
  24. - :ref:`Environment<class_environment>` **environment** - The World's :ref:`Environment<class_environment>`.
  25. .. _class_World_fallback_environment:
  26. - :ref:`Environment<class_environment>` **fallback_environment** - The World's fallback_environment will be used if the World's :ref:`Environment<class_environment>` fails or is missing.
  27. Description
  28. -----------
  29. Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_World_get_direct_space_state:
  33. - :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **get_direct_space_state** **(** **)**
  34. Returns the World's physics space.
  35. .. _class_World_get_scenario:
  36. - :ref:`RID<class_rid>` **get_scenario** **(** **)** const
  37. Returns the World's visual scenario.
  38. .. _class_World_get_space:
  39. - :ref:`RID<class_rid>` **get_space** **(** **)** const
  40. Returns the World's sound space.