Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_world.rst

class_world.rst 4.6 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the World.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_World:
    6. 

  6. 

  7. World
    8. 

  8. =====
    9. 

  9. 

  10. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Class that has everything pertaining to a world.
    18. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`  | :ref:`get_direct_space_state<class_World_get_direct_space_state>`  **(** **)**                                                |
    24. 

  24. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`Environment<class_environment>`                          | :ref:`get_environment<class_World_get_environment>`  **(** **)** const                                                        |
    26. 

  26. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Environment<class_environment>`                          | :ref:`get_fallback_environment<class_World_get_fallback_environment>`  **(** **)** const                                      |
    28. 

  28. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`RID<class_rid>`                                          | :ref:`get_scenario<class_World_get_scenario>`  **(** **)** const                                                              |
    30. 

  30. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`RID<class_rid>`                                          | :ref:`get_space<class_World_get_space>`  **(** **)** const                                                                    |
    32. 

  32. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | void                                                           | :ref:`set_environment<class_World_set_environment>`  **(** :ref:`Environment<class_environment>` env  **)**                   |
    34. 

  34. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | void                                                           | :ref:`set_fallback_environment<class_World_set_fallback_environment>`  **(** :ref:`Environment<class_environment>` env  **)** |
    36. 

  36. +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. 

  38. Member Variables
    39. 

  39. ----------------
    40. 

  40. 

  41. - :ref:`Environment<class_environment>` **environment**
    42. 

  42. - :ref:`Environment<class_environment>` **fallback_environment**
    43. 

  43. 

  44. Description
    45. 

  45. -----------
    46. 

  46. 

  47. 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.
    48. 

  48. 

  49. Member Function Description
    50. 

  50. ---------------------------
    51. 

  51. 

  52. .. _class_World_get_direct_space_state:
    53. 

  53. 

  54. - :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>`  **get_direct_space_state**  **(** **)**
    55. 

  55. 

  56. .. _class_World_get_environment:
    57. 

  57. 

  58. - :ref:`Environment<class_environment>`  **get_environment**  **(** **)** const
    59. 

  59. 

  60. .. _class_World_get_fallback_environment:
    61. 

  61. 

  62. - :ref:`Environment<class_environment>`  **get_fallback_environment**  **(** **)** const
    63. 

  63. 

  64. .. _class_World_get_scenario:
    65. 

  65. 

  66. - :ref:`RID<class_rid>`  **get_scenario**  **(** **)** const
    67. 

  67. 

  68. .. _class_World_get_space:
    69. 

  69. 

  70. - :ref:`RID<class_rid>`  **get_space**  **(** **)** const
    71. 

  71. 

  72. .. _class_World_set_environment:
    73. 

  73. 

  74. - void  **set_environment**  **(** :ref:`Environment<class_environment>` env  **)**
    75. 

  75. 

  76. .. _class_World_set_fallback_environment:
    77. 

  77. 

  78. - void  **set_fallback_environment**  **(** :ref:`Environment<class_environment>` env  **)**
    79. 

  79. 

  80.