:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the World3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_World3D:

World3D
=======

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Class that has everything pertaining to a world.

Description
-----------

Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Node3D nodes register their resources into the current world.

Tutorials
---------

- :doc:`Ray-casting <../tutorials/physics/ray-casting>`

Properties
----------

+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`CameraEffects<class_CameraEffects>`                         | :ref:`camera_effects<class_World3D_property_camera_effects>`             |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` | :ref:`direct_space_state<class_World3D_property_direct_space_state>`     |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`Environment<class_Environment>`                             | :ref:`environment<class_World3D_property_environment>`                   |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`Environment<class_Environment>`                             | :ref:`fallback_environment<class_World3D_property_fallback_environment>` |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`navigation_map<class_World3D_property_navigation_map>`             |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`scenario<class_World3D_property_scenario>`                         |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
| :ref:`RID<class_RID>`                                             | :ref:`space<class_World3D_property_space>`                               |
+-------------------------------------------------------------------+--------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_World3D_property_camera_effects:

- :ref:`CameraEffects<class_CameraEffects>` **camera_effects**

+----------+---------------------------+
| *Setter* | set_camera_effects(value) |
+----------+---------------------------+
| *Getter* | get_camera_effects()      |
+----------+---------------------------+

----

.. _class_World3D_property_direct_space_state:

- :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **direct_space_state**

+----------+--------------------------+
| *Getter* | get_direct_space_state() |
+----------+--------------------------+

Direct access to the world's physics 3D space state. Used for querying current and potential collisions.

----

.. _class_World3D_property_environment:

- :ref:`Environment<class_Environment>` **environment**

+----------+------------------------+
| *Setter* | set_environment(value) |
+----------+------------------------+
| *Getter* | get_environment()      |
+----------+------------------------+

The World3D's :ref:`Environment<class_Environment>`.

----

.. _class_World3D_property_fallback_environment:

- :ref:`Environment<class_Environment>` **fallback_environment**

+----------+---------------------------------+
| *Setter* | set_fallback_environment(value) |
+----------+---------------------------------+
| *Getter* | get_fallback_environment()      |
+----------+---------------------------------+

The World3D's fallback_environment will be used if the World3D's :ref:`Environment<class_Environment>` fails or is missing.

----

.. _class_World3D_property_navigation_map:

- :ref:`RID<class_RID>` **navigation_map**

+----------+----------------------+
| *Getter* | get_navigation_map() |
+----------+----------------------+

The :ref:`RID<class_RID>` of this world's navigation map. Used by the :ref:`NavigationServer3D<class_NavigationServer3D>`.

----

.. _class_World3D_property_scenario:

- :ref:`RID<class_RID>` **scenario**

+----------+----------------+
| *Getter* | get_scenario() |
+----------+----------------+

The World3D's visual scenario.

----

.. _class_World3D_property_space:

- :ref:`RID<class_RID>` **space**

+----------+-------------+
| *Getter* | get_space() |
+----------+-------------+

The World3D'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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`