159 lines
5.6 KiB
ReStructuredText
159 lines
5.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/World.xml.
|
|
|
|
.. _class_World:
|
|
|
|
World
|
|
=====
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Class that has everything pertaining to a world.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class that has everything pertaining to a world. A physics space, a visual scenario, a navigation map and a sound space. Spatial nodes register their resources into the current world.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/physics/ray-casting`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>` | :ref:`direct_space_state<class_World_property_direct_space_state>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`Environment<class_Environment>` | :ref:`environment<class_World_property_environment>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`Environment<class_Environment>` | :ref:`fallback_environment<class_World_property_fallback_environment>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`navigation_map<class_World_property_navigation_map>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`scenario<class_World_property_scenario>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`space<class_World_property_space>` |
|
|
+---------------------------------------------------------------+------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_World_property_direct_space_state:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>` **direct_space_state**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>` **get_direct_space_state** **(** **)**
|
|
|
|
Direct access to the world's physics 3D space state. Used for querying current and potential collisions.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World_property_environment:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Environment<class_Environment>` **environment**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_environment** **(** :ref:`Environment<class_Environment>` value **)**
|
|
- :ref:`Environment<class_Environment>` **get_environment** **(** **)**
|
|
|
|
The World's :ref:`Environment<class_Environment>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World_property_fallback_environment:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Environment<class_Environment>` **fallback_environment**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_fallback_environment** **(** :ref:`Environment<class_Environment>` value **)**
|
|
- :ref:`Environment<class_Environment>` **get_fallback_environment** **(** **)**
|
|
|
|
The World's fallback environment will be used if :ref:`environment<class_World_property_environment>` fails or is missing.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World_property_navigation_map:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **navigation_map**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`RID<class_RID>` **get_navigation_map** **(** **)**
|
|
|
|
The :ref:`RID<class_RID>` of this world's navigation map. Used by the :ref:`NavigationServer<class_NavigationServer>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World_property_scenario:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **scenario**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`RID<class_RID>` **get_scenario** **(** **)**
|
|
|
|
The World's visual scenario.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World_property_space:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **space**
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`RID<class_RID>` **get_space** **(** **)**
|
|
|
|
The World's physics space.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|