virtualx-engine/doc/classes/World3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="World3D" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Class that has everything pertaining to a world.
	</brief_description>
	<description>
		Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Node3D nodes register their resources into the current world.
	</description>
	<tutorials>
		<link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link>
	</tutorials>
	<members>
		<member name="camera_attributes" type="CameraAttributes" setter="set_camera_attributes" getter="get_camera_attributes">
			The default [CameraAttributes] resource to use if none set on the [Camera3D].
		</member>
		<member name="direct_space_state" type="PhysicsDirectSpaceState3D" setter="" getter="get_direct_space_state">
			Direct access to the world's physics 3D space state. Used for querying current and potential collisions.
		</member>
		<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
			The World3D's [Environment].
		</member>
		<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment">
			The World3D's fallback environment will be used if [member environment] fails or is missing.
		</member>
		<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">
			The [RID] of this world's navigation map. Used by the [NavigationServer3D].
		</member>
		<member name="scenario" type="RID" setter="" getter="get_scenario">
			The World3D's visual scenario.
		</member>
		<member name="space" type="RID" setter="" getter="get_space">
			The World3D's physics space.
		</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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="World3D" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
			`Class that has everything pertaining to a world.`
			`</brief_description>`
			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Node3D nodes register their resources into the current world.`
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>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`<link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</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>`
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes. 2022-08-01 01:20:24 +02:00			`<member name="camera_attributes" type="CameraAttributes" setter="set_camera_attributes" getter="get_camera_attributes">`
			`The default [CameraAttributes] resource to use if none set on the [Camera3D].`
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>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`<member name="direct_space_state" type="PhysicsDirectSpaceState3D" setter="" getter="get_direct_space_state">`
Remove the unnecessary sync() and the restrictions it imposes on 3D Physics. 2020-09-18 11:07:00 +02:00			`Direct access to the world's physics 3D space state. Used for querying current and potential collisions.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</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">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`The World3D's [Environment].`
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>`
doc: Sync classref with current source 2019-07-15 20:42:47 +02:00			`<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment">`
Classref typo fixes and improvements 2022-06-17 09:15:30 +02:00			`The World3D's fallback environment will be used if [member environment] fails or is missing.`
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>`
Remove Navigation2D/3D nodes, and move the navigation map to the world resource 2021-03-08 09:47:18 +01:00			`<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">`
			`The [RID] of this world's navigation map. Used by the [NavigationServer3D].`
			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 21:22:15 +02:00			`<member name="scenario" type="RID" setter="" getter="get_scenario">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`The World3D's visual scenario.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 21:22:15 +02:00			`<member name="space" type="RID" setter="" getter="get_space">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`The World3D's physics space.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
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			`</members>`
			`</class>`