Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Synchronizes properties from the multiplayer authority to the remote peers.
By default, MultiplayerSynchronizer synchronizes configured properties to all peers.
Internally, MultiplayerSynchronizer uses MultiplayerAPI.object_configuration_add to notify synchronization start passing the Node at root_path as the
object and itself as the
configuration, and uses MultiplayerAPI.object_configuration_remove to notify synchronization end in a similar way.
Note: Synchronization is not supported for Object type properties, like Resource. Properties that are unique to each peer, like the instance IDs of Objects (see Object.get_instance_id) or RIDs, will also not work in synchronization.
delta_synchronized ( )
Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated.
synchronized ( )
Emitted when a new synchronization state is received by this synchronizer after the properties have been updated.
visibility_changed ( int for_peer )
Emitted when visibility of
for_peer is updated. See update_visibility.
VisibilityUpdateMode VISIBILITY_PROCESS_IDLE =
Visibility filters are updated during process frames (see Node.NOTIFICATION_INTERNAL_PROCESS).
VisibilityUpdateMode VISIBILITY_PROCESS_PHYSICS =
Visibility filters are updated during physics frames (see Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS).
VisibilityUpdateMode VISIBILITY_PROCESS_NONE =
Visibility filters are not updated automatically, and must be updated manually by calling update_visibility.
float delta_interval =
Time interval between delta synchronizations. When set to
0.0 (the default), delta synchronizations happen every network process frame.
bool public_visibility =
void set_replication_config ( SceneReplicationConfig value )
SceneReplicationConfig get_replication_config ( )
Resource containing which properties to synchronize.
float replication_interval =
Time interval between synchronizations. When set to
0.0 (the default), synchronizations happen every network process frame.
NodePath root_path =
Node path that replicated properties are relative to.
VisibilityUpdateMode visibility_update_mode =
void set_visibility_update_mode ( VisibilityUpdateMode value )
VisibilityUpdateMode get_visibility_update_mode ( )
Specifies when visibility filters are updated (see VisibilityUpdateMode for options).
void add_visibility_filter ( Callable filter )
Adds a peer visibility filter for this synchronizer.
Queries the current visibility for peer
void remove_visibility_filter ( Callable filter )
Removes a peer visibility filter from this synchronizer.
Sets the visibility of
0, the value of public_visibility will be updated instead.
void update_visibility ( int for_peer=0 )
Updates the visibility of
for_peer according to visibility filters. If
0 (the default), all peers' visibilties are updated.