mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
184 lines
7.5 KiB
ReStructuredText
184 lines
7.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/World3D.xml.
|
|
|
|
.. _class_World3D:
|
|
|
|
World3D
|
|
=======
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A resource that holds all components of a 3D world, such as a visual scenario and a physics space.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class that has everything pertaining to a world: A physics space, a visual scenario, and a sound space. 3D nodes register their resources into the current 3D world.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Ray-casting <../tutorials/physics/ray-casting>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
|
|
| :ref:`CameraAttributes<class_CameraAttributes>` | :ref:`camera_attributes<class_World3D_property_camera_attributes>` |
|
|
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
|
|
| :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>` |
|
|
+-------------------------------------------------------------------+--------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_World3D_property_camera_attributes:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`CameraAttributes<class_CameraAttributes>` **camera_attributes** :ref:`🔗<class_World3D_property_camera_attributes>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_camera_attributes**\ (\ value\: :ref:`CameraAttributes<class_CameraAttributes>`\ )
|
|
- :ref:`CameraAttributes<class_CameraAttributes>` **get_camera_attributes**\ (\ )
|
|
|
|
The default :ref:`CameraAttributes<class_CameraAttributes>` resource to use if none set on the :ref:`Camera3D<class_Camera3D>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_direct_space_state:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **direct_space_state** :ref:`🔗<class_World3D_property_direct_space_state>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **get_direct_space_state**\ (\ )
|
|
|
|
Direct access to the world's physics 3D space state. Used for querying current and potential collisions. When using multi-threaded physics, access is limited to :ref:`Node._physics_process()<class_Node_private_method__physics_process>` in the main thread.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_environment:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Environment<class_Environment>` **environment** :ref:`🔗<class_World3D_property_environment>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_environment**\ (\ value\: :ref:`Environment<class_Environment>`\ )
|
|
- :ref:`Environment<class_Environment>` **get_environment**\ (\ )
|
|
|
|
The World3D's :ref:`Environment<class_Environment>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_fallback_environment:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Environment<class_Environment>` **fallback_environment** :ref:`🔗<class_World3D_property_fallback_environment>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_fallback_environment**\ (\ value\: :ref:`Environment<class_Environment>`\ )
|
|
- :ref:`Environment<class_Environment>` **get_fallback_environment**\ (\ )
|
|
|
|
The World3D's fallback environment will be used if :ref:`environment<class_World3D_property_environment>` fails or is missing.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_navigation_map:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **navigation_map** :ref:`🔗<class_World3D_property_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:`NavigationServer3D<class_NavigationServer3D>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_scenario:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **scenario** :ref:`🔗<class_World3D_property_scenario>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`RID<class_RID>` **get_scenario**\ (\ )
|
|
|
|
The World3D's visual scenario.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_World3D_property_space:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID<class_RID>` **space** :ref:`🔗<class_World3D_property_space>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- :ref:`RID<class_RID>` **get_space**\ (\ )
|
|
|
|
The World3D's physics space.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|