virtualx-engine/doc/classes/WorldEnvironment.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="WorldEnvironment" inherits="Node" version="4.0">
	<brief_description>
		Default environment properties for the entire scene (post-processing effects, lighting and background settings).
	</brief_description>
	<description>
		The [WorldEnvironment] node is used to configure the default [Environment] for the scene.
		The parameters defined in the [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera3D]. Additionally, only one [WorldEnvironment] may be instantiated 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). Usually, these are added in order to improve the realism/color balance of the scene.
	</description>
	<tutorials>
		<link title="Environment and post-processing">https://docs.godotengine.org/en/latest/tutorials/3d/environment_and_post_processing.html</link>
		<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>
		<link title="2D HDR Demo">https://godotengine.org/asset-library/asset/110</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<members>
		<member name="camera_effects" type="CameraEffects" setter="set_camera_effects" getter="get_camera_effects">
		</member>
		<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
			The [Environment] resource used by this [WorldEnvironment], defining the default properties.
		</member>
	</members>
</class>
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. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="WorldEnvironment" inherits="Node" version="4.0">`
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. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Update WorldEnvironment.xml 2018-12-12 12:32:26 +01:00			`Default environment properties for the entire scene (post-processing effects, lighting and background settings).`
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. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`The [WorldEnvironment] node is used to configure the default [Environment] for the scene.`
Rename `instance()`->`instantiate()` when it's a verb 2021-06-18 00:03:09 +02:00			`The parameters defined in the [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera3D]. Additionally, only one [WorldEnvironment] may be instantiated in a given scene at a time.`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`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). Usually, these are added in order to improve the realism/color balance of the scene.`
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. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.) 2020-08-05 14:43:40 +02:00			`<link title="Environment and post-processing">https://docs.godotengine.org/en/latest/tutorials/3d/environment_and_post_processing.html</link>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>`
			`<link title="2D HDR Demo">https://godotengine.org/asset-library/asset/110</link>`
			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
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. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`<members>`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`<member name="camera_effects" type="CameraEffects" setter="set_camera_effects" getter="get_camera_effects">`
			`</member>`
doc: Sync classref with current source 2019-07-15 20:42:47 +02:00			`<member name="environment" type="Environment" setter="set_environment" getter="get_environment">`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`The [Environment] resource used by this [WorldEnvironment], defining the default properties.`
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. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`</class>`