| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- :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/WorldEnvironment.xml.
- .. _class_WorldEnvironment:
- WorldEnvironment
- ================
- **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Default environment properties for the entire scene (post-processing effects, lighting and background settings).
- .. rst-class:: classref-introduction-group
- Description
- -----------
- The **WorldEnvironment** node is used to configure the default :ref:`Environment<class_Environment>` for the scene.
- The parameters defined in the **WorldEnvironment** can be overridden by an :ref:`Environment<class_Environment>` node set on the current :ref:`Camera3D<class_Camera3D>`. Additionally, only one **WorldEnvironment** may be instantiated in a given scene at a time.
- The **WorldEnvironment** allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Environment and post-processing <../tutorials/3d/environment_and_post_processing>`
- - `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`__
- - `2D HDR Demo <https://godotengine.org/asset-library/asset/110>`__
- - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-------------------------------------------------+-----------------------------------------------------------------------------+
- | :ref:`CameraAttributes<class_CameraAttributes>` | :ref:`camera_attributes<class_WorldEnvironment_property_camera_attributes>` |
- +-------------------------------------------------+-----------------------------------------------------------------------------+
- | :ref:`Environment<class_Environment>` | :ref:`environment<class_WorldEnvironment_property_environment>` |
- +-------------------------------------------------+-----------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_WorldEnvironment_property_camera_attributes:
- .. rst-class:: classref-property
- :ref:`CameraAttributes<class_CameraAttributes>` **camera_attributes**
- .. rst-class:: classref-property-setget
- - void **set_camera_attributes** **(** :ref:`CameraAttributes<class_CameraAttributes>` value **)**
- - :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_WorldEnvironment_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 :ref:`Environment<class_Environment>` resource used by this **WorldEnvironment**, defining the default properties.
- .. |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.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
