Files
godot-docs/classes/class_worldenvironment.rst
2017-11-27 08:32:15 +01:00

32 lines
1.2 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_WorldEnvironment:
WorldEnvironment
================
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Sets environment properties for the entire scene
Member Variables
----------------
.. _class_WorldEnvironment_environment:
- :ref:`Environment<class_environment>` **environment**
Description
-----------
The ``WorldEnvironment`` node can be added to a scene in order to set default :ref:`Environment<class_environment>` variables for the scene. The ``WorldEnvironment`` can be overridden by an :ref:`Environment<class_environment>` node set on the current :ref:`Camera<class_camera>`. Additionally, only one ``WorldEnvironment`` may be instanced 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).