1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the World.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_World:
- World
- =====
- **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Class that has everything pertaining to a world.
- Member Functions
- ----------------
- +----------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`get_direct_space_state<class_World_get_direct_space_state>` **(** **)** |
- +----------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`RID<class_rid>` | :ref:`get_scenario<class_World_get_scenario>` **(** **)** const |
- +----------------------------------------------------------------+-------------------------------------------------------------------------------+
- | :ref:`RID<class_rid>` | :ref:`get_space<class_World_get_space>` **(** **)** const |
- +----------------------------------------------------------------+-------------------------------------------------------------------------------+
- Member Variables
- ----------------
- .. _class_World_environment:
- - :ref:`Environment<class_environment>` **environment** - The World's :ref:`Environment<class_environment>`.
- .. _class_World_fallback_environment:
- - :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.
- Description
- -----------
- 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.
- Member Function Description
- ---------------------------
- .. _class_World_get_direct_space_state:
- - :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **get_direct_space_state** **(** **)**
- Returns the World's physics space.
- .. _class_World_get_scenario:
- - :ref:`RID<class_rid>` **get_scenario** **(** **)** const
- Returns the World's visual scenario.
- .. _class_World_get_space:
- - :ref:`RID<class_rid>` **get_space** **(** **)** const
- Returns the World's sound space.
|