summaryrefslogtreecommitdiff
path: root/modules/multiplayer/doc_classes/SceneReplicationConfig.xml
blob: fc91592c7ac216439ca505fcd2e088937607998d (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SceneReplicationConfig" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Configuration for properties to synchronize with a [MultiplayerSynchronizer].
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_property">
			<return type="void" />
			<argument index="0" name="path" type="NodePath" />
			<argument index="1" name="index" type="int" default="-1" />
			<description>
				Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code].
			</description>
		</method>
		<method name="get_properties" qualifiers="const">
			<return type="NodePath[]" />
			<description>
				Returns a list of synchronized property [NodePath]s.
			</description>
		</method>
		<method name="has_property" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="path" type="NodePath" />
			<description>
				Returns whether the given [code]path[/code] is configured for synchronization.
			</description>
		</method>
		<method name="property_get_index" qualifiers="const">
			<return type="int" />
			<argument index="0" name="path" type="NodePath" />
			<description>
				Finds the index of the given [code]path[/code].
			</description>
		</method>
		<method name="property_get_spawn">
			<return type="bool" />
			<argument index="0" name="path" type="NodePath" />
			<description>
				Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
			</description>
		</method>
		<method name="property_get_sync">
			<return type="bool" />
			<argument index="0" name="path" type="NodePath" />
			<description>
				Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
			</description>
		</method>
		<method name="property_set_spawn">
			<return type="void" />
			<argument index="0" name="path" type="NodePath" />
			<argument index="1" name="enabled" type="bool" />
			<description>
				Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
			</description>
		</method>
		<method name="property_set_sync">
			<return type="void" />
			<argument index="0" name="path" type="NodePath" />
			<argument index="1" name="enabled" type="bool" />
			<description>
				Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
			</description>
		</method>
		<method name="remove_property">
			<return type="void" />
			<argument index="0" name="path" type="NodePath" />
			<description>
				Removes the property identified by the given [code]path[/code] from the configuration.
			</description>
		</method>
	</methods>
</class>