class_worldenvironment.rst 1.2 KB

12345678910111213141516171819202122232425262728293031
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_WorldEnvironment:
  5. WorldEnvironment
  6. ================
  7. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Sets environment properties for the entire scene
  12. Member Variables
  13. ----------------
  14. .. _class_WorldEnvironment_environment:
  15. - :ref:`Environment<class_environment>` **environment**
  16. Description
  17. -----------
  18. 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).