diff options
| author | Juan Linietsky | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/WorldEnvironment.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
| download | godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/WorldEnvironment.xml')
| -rw-r--r-- | doc/classes/WorldEnvironment.xml | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml new file mode 100644 index 000000000..24606b59b --- /dev/null +++ b/doc/classes/WorldEnvironment.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <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> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + Return the [Environment] currently bound. + </description> + </method> + <method name="set_environment"> + <return type="void"> + </return> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + Set the currently bound [Environment] to the one specified. + </description> + </method> + </methods> + <members> + <member name="environment" type="Environment" setter="set_environment" getter="get_environment" brief=""> + </member> + </members> + <constants> + </constants> +</class> |