summaryrefslogtreecommitdiffstats
path: root/modules
diff options
context:
space:
mode:
authorThaddeus Crews <repiteo@outlook.com>2024-11-15 10:42:47 -0600
committerThaddeus Crews <repiteo@outlook.com>2024-11-15 10:42:47 -0600
commite4608dd6c2350c5025bf9f36755ffa97d68caf0f (patch)
treeaabac741bded9ba4c34d9c00fb62dad12efd836e /modules
parent773c8e9a934479705d7218b984e4c378651e928b (diff)
parentf72b8413906fa075a73572d207d5d8b5fd687db4 (diff)
downloadredot-engine-e4608dd6c2350c5025bf9f36755ffa97d68caf0f.tar.gz
Merge pull request #98138 from CrayolaEater/better-explanation-mp-sync
Better explanation for replication interval and delta interval (MultiplayerSynchronizer)
Diffstat (limited to 'modules')
-rw-r--r--modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml
index c2d879962c..edcaa3baef 100644
--- a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml
+++ b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml
@@ -53,7 +53,7 @@
</methods>
<members>
<member name="delta_interval" type="float" setter="set_delta_interval" getter="get_delta_interval" default="0.0">
- Time interval between delta synchronizations. When set to [code]0.0[/code] (the default), delta synchronizations happen every network process frame.
+ Time interval between delta synchronizations. Used when the replication is set to [constant SceneReplicationConfig.REPLICATION_MODE_ON_CHANGE]. If set to [code]0.0[/code] (the default), delta synchronizations happen every network process frame.
</member>
<member name="public_visibility" type="bool" setter="set_visibility_public" getter="is_visibility_public" default="true">
Whether synchronization should be visible to all peers by default. See [method set_visibility_for] and [method add_visibility_filter] for ways of configuring fine-grained visibility options.
@@ -62,7 +62,7 @@
Resource containing which properties to synchronize.
</member>
<member name="replication_interval" type="float" setter="set_replication_interval" getter="get_replication_interval" default="0.0">
- Time interval between synchronizations. When set to [code]0.0[/code] (the default), synchronizations happen every network process frame.
+ Time interval between synchronizations. Used when the replication is set to [constant SceneReplicationConfig.REPLICATION_MODE_ALWAYS]. If set to [code]0.0[/code] (the default), synchronizations happen every network process frame.
</member>
<member name="root_path" type="NodePath" setter="set_root_path" getter="get_root_path" default="NodePath(&quot;..&quot;)">
Node path that replicated properties are relative to.