summaryrefslogtreecommitdiff
path: root/doc/classes/World3D.xml
blob: 5e58bb03606262e99e0dc97b3fb65b6c0cfd535a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?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. When using multi-threaded physics, access is limited to [method Node._physics_process] in the main thread.
		</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>