Skip to main content

Struct SyncSettings

Syntax​
[Serializable]
public struct SyncSettings

Fields​

INTERVAL_TOOLTIP​

Declaration​
public const string INTERVAL_TOOLTIP = "Time in seconds until next change is synchronized to the client. '0' means send immediately if changed. '0.5' means only send changes every 500ms.\n(This is for state synchronization like SyncVars, SyncLists, OnSerialize. Not for Cmds, Rpcs, etc.)"

From​

Declaration​
public SyncFrom From

To​

Declaration​
public SyncTo To

Timing​

Declaration​
public SyncTiming Timing

Interval​

Declaration​
public float Interval

Default​

Declaration​
public static readonly SyncSettings Default

Methods​

UpdateTime(ref Double, Double)​

Declaration​
public void UpdateTime(ref double nextSyncTime, double now)
Parameters​
TypeNameDescription
System.DoublenextSyncTime
System.Doublenow

UpdateTime(Single, SyncTiming, ref Double, Double)​

Declaration​
public static void UpdateTime(float interval, SyncTiming timing, ref double nextSyncTime, double now)
Parameters​
TypeNameDescription
System.Singleinterval
Mirage.SyncTimingtiming
System.DoublenextSyncTime
System.Doublenow

ShouldSyncFrom(NetworkIdentity, Boolean)​

Declaration​
public bool ShouldSyncFrom(NetworkIdentity identity, bool syncInHostMode)
Parameters​
TypeNameDescription
Mirage.NetworkIdentityidentity
System.BooleansyncInHostMode
Returns​
TypeDescription
System.Boolean

ToObserverWriterOnly(NetworkIdentity)​

Declaration​
public bool ToObserverWriterOnly(NetworkIdentity identity)
Parameters​
TypeNameDescription
Mirage.NetworkIdentityidentity
Returns​
TypeDescription
System.Boolean

CopyToObservers(NetworkIdentity)​

Declaration​
public bool CopyToObservers(NetworkIdentity identity)
Parameters​
TypeNameDescription
Mirage.NetworkIdentityidentity
Returns​
TypeDescription
System.Boolean

IsValidDirection(SyncFrom, SyncTo)​

Declaration​
public static bool IsValidDirection(SyncFrom from, SyncTo to)
Parameters​
TypeNameDescription
Mirage.SyncFromfrom
Mirage.SyncToto
Returns​
TypeDescription
System.Boolean

InvalidReason(SyncFrom, SyncTo)​

Declaration​
public static string InvalidReason(SyncFrom from, SyncTo to)
Parameters​
TypeNameDescription
Mirage.SyncFromfrom
Mirage.SyncToto
Returns​
TypeDescription
System.String