class_world.rst 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_World:
  4. World
  5. =====
  6. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Class that has everything pertaining to a world.
  11. Member Functions
  12. ----------------
  13. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  14. | :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`get_direct_space_state<class_World_get_direct_space_state>` **(** **)** |
  15. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Environment<class_environment>` | :ref:`get_environment<class_World_get_environment>` **(** **)** const |
  17. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  18. | :ref:`RID<class_rid>` | :ref:`get_scenario<class_World_get_scenario>` **(** **)** const |
  19. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  20. | :ref:`RID<class_rid>` | :ref:`get_sound_space<class_World_get_sound_space>` **(** **)** const |
  21. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  22. | :ref:`RID<class_rid>` | :ref:`get_space<class_World_get_space>` **(** **)** const |
  23. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_environment<class_World_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
  25. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
  26. Description
  27. -----------
  28. 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.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_World_get_direct_space_state:
  32. - :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **get_direct_space_state** **(** **)**
  33. .. _class_World_get_environment:
  34. - :ref:`Environment<class_environment>` **get_environment** **(** **)** const
  35. .. _class_World_get_scenario:
  36. - :ref:`RID<class_rid>` **get_scenario** **(** **)** const
  37. .. _class_World_get_sound_space:
  38. - :ref:`RID<class_rid>` **get_sound_space** **(** **)** const
  39. .. _class_World_get_space:
  40. - :ref:`RID<class_rid>` **get_space** **(** **)** const
  41. .. _class_World_set_environment:
  42. - void **set_environment** **(** :ref:`Environment<class_environment>` env **)**