Files
godot-docs/classes/class_world.rst
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02:00

68 lines
3.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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:`Environment<class_environment>` | :ref:`get_environment<class_World_get_environment>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_scenario<class_World_get_scenario>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_sound_space<class_World_get_sound_space>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_space<class_World_get_space>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_environment<class_World_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
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** **(** **)**
.. _class_World_get_environment:
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
.. _class_World_get_scenario:
- :ref:`RID<class_rid>` **get_scenario** **(** **)** const
.. _class_World_get_sound_space:
- :ref:`RID<class_rid>` **get_sound_space** **(** **)** const
.. _class_World_get_space:
- :ref:`RID<class_rid>` **get_space** **(** **)** const
.. _class_World_set_environment:
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**