summaryrefslogtreecommitdiff
path: root/doc/classes/World.xml
blob: 9011d3966903d8bf6060fd061960f3f34057ebe1 (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
36
37
38
39
40
41
42
43
44
45
46
<?xml version="1.0" encoding="UTF-8" ?>
<class name="World" inherits="Resource" category="Core" version="3.0-beta">
	<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. Spatial nodes register their resources into the current world.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_direct_space_state">
			<return type="PhysicsDirectSpaceState">
			</return>
			<description>
				Returns the World's physics space.
			</description>
		</method>
		<method name="get_scenario" qualifiers="const">
			<return type="RID">
			</return>
			<description>
				Returns the World's visual scenario.
			</description>
		</method>
		<method name="get_space" qualifiers="const">
			<return type="RID">
			</return>
			<description>
				Returns the World's sound space.
			</description>
		</method>
	</methods>
	<members>
		<member name="environment" type="Environment" setter="set_environment" getter="get_environment">
			The World's [Environment].
		</member>
		<member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment">
			The World's fallback_environment will be used if the World's [Environment] fails or is missing.
		</member>
	</members>
	<constants>
	</constants>
</class>