summaryrefslogtreecommitdiff
path: root/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml
blob: ebd1b50201904703b57c4caa20de0136d3b3609c (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MultiplayerSynchronizer" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
	</brief_description>
	<description>
		The [MultiplayerSynchronizer] uses [method MultiplayerAPI.object_configuration_add] to notify synchronization start passing the [Node] at [member root_path] as the [code]object[/code] and itself as the [code]configuration[/code], and uses [method MultiplayerAPI.object_configuration_remove] to notify synchronization end in a similar way.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_visibility_filter">
			<return type="void" />
			<argument index="0" name="filter" type="Callable" />
			<description>
			</description>
		</method>
		<method name="get_visibility_for" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="peer" type="int" />
			<description>
			</description>
		</method>
		<method name="remove_visibility_filter">
			<return type="void" />
			<argument index="0" name="filter" type="Callable" />
			<description>
			</description>
		</method>
		<method name="set_visibility_for">
			<return type="void" />
			<argument index="0" name="peer" type="int" />
			<argument index="1" name="visible" type="bool" />
			<description>
			</description>
		</method>
		<method name="update_visibility">
			<return type="void" />
			<argument index="0" name="for_peer" type="int" default="0" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="public_visibility" type="bool" setter="set_visibility_public" getter="is_visibility_public" default="true">
		</member>
		<member name="replication_config" type="SceneReplicationConfig" setter="set_replication_config" getter="get_replication_config">
		</member>
		<member name="replication_interval" type="float" setter="set_replication_interval" getter="get_replication_interval" default="0.0">
		</member>
		<member name="root_path" type="NodePath" setter="set_root_path" getter="get_root_path" default="NodePath(&quot;..&quot;)">
		</member>
		<member name="visibility_update_mode" type="int" setter="set_visibility_update_mode" getter="get_visibility_update_mode" enum="MultiplayerSynchronizer.VisibilityUpdateMode" default="0">
		</member>
	</members>
	<signals>
		<signal name="visibility_changed">
			<argument index="0" name="for_peer" type="int" />
			<description>
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="VISIBILITY_PROCESS_IDLE" value="0" enum="VisibilityUpdateMode">
		</constant>
		<constant name="VISIBILITY_PROCESS_PHYSICS" value="1" enum="VisibilityUpdateMode">
		</constant>
		<constant name="VISIBILITY_PROCESS_NONE" value="2" enum="VisibilityUpdateMode">
		</constant>
	</constants>
</class>