summaryrefslogtreecommitdiff
path: root/doc/classes/WorldEnvironment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/WorldEnvironment.xml')
-rw-r--r--doc/classes/WorldEnvironment.xml10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml
index 44f2086e51..468e618e72 100644
--- a/doc/classes/WorldEnvironment.xml
+++ b/doc/classes/WorldEnvironment.xml
@@ -1,12 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-beta">
+<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0-stable">
<brief_description>
- Sets environment properties for the entire scene
+ Default environment properties for the entire scene (post-processing effects, lightning and background settings).
</brief_description>
<description>
- The [code]WorldEnvironment[/code] node can be added to a scene in order to set default [Environment] variables for the scene. The [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time. The [code]WorldEnvironment[/code] 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).
+ The [code]WorldEnvironment[/code] node is used to configure the default [Environment] for the scene.
+ The parameters defined in the [code]WorldEnvironment[/code] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [code]WorldEnvironment[/code] may be instanced in a given scene at a time.
+ The [code]WorldEnvironment[/code] 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.
</description>
<tutorials>
+ http://docs.godotengine.org/en/3.0/tutorials/3d/environment_and_post_processing.html
</tutorials>
<demos>
</demos>
@@ -14,6 +17,7 @@
</methods>
<members>
<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
+ The [Environment] resource used by this [code]WorldEnvironment[/code], defining the default properties.
</member>
</members>
<constants>