diff options
| author | clayjohn <clayjohn@shaw.ca> | 2017-04-24 12:51:27 -0600 |
|---|---|---|
| committer | clayjohn <clayjohn@shaw.ca> | 2017-04-24 13:45:57 -0600 |
| commit | 5fdc7ac88a46f062fb2d9052292e3d8319fca847 (patch) | |
| tree | 33f12323ed526267567b064a8b984797ff63f86a /doc/base | |
| parent | b6e0eaf3ca74d9777c6869d8519db6264866d1e6 (diff) | |
added descriptions for WorldEnvironment node in documentation
Diffstat (limited to 'doc/base')
| -rw-r--r-- | doc/base/classes.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index e0e88ef348..766f1877a2 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -51969,20 +51969,24 @@ do_property]. </class> <class name="WorldEnvironment" inherits="Spatial" category="Core"> <brief_description> + Sets environment properties for the entire scene </brief_description> <description> + The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [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). </description> <methods> <method name="get_environment" qualifiers="const"> <return type="Environment"> </return> <description> + Return the [Environment] currently bound. </description> </method> <method name="set_environment"> <argument index="0" name="env" type="Environment"> </argument> <description> + Set the currently bound [Environment] to the one specified. </description> </method> </methods> @@ -52307,3 +52311,4 @@ do_property]. </constants> </class> </doc> + |