Mirror.SyncVar< T > Class Template Reference

Inheritance diagram for Mirror.SyncVar< T >:

Public Member Functions
override void	ClearChanges ()
	Discard all the queued changes More...
override void	Reset ()
	Resets the SyncObject so that it can be re-used More...
	SyncVar (T value)
override void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
override void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
override void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
override void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
bool	Equals (T other)
override string	ToString ()
abstract void	ClearChanges ()
	Discard all the queued changes More...
abstract void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
abstract void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
abstract void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
abstract void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
abstract void	Reset ()
	Resets the SyncObject so that it can be re-used More...

Static Public Member Functions
static implicit	operator T (SyncVar< T > field)
static implicit	operator SyncVar< T > (T value)

Protected Member Functions
virtual void	InvokeCallback (T oldValue, T newValue)

Properties
virtual T	Value [get, set]

Events
Action< T, T >	Callback

Additional Inherited Members
Public Attributes inherited from Mirror.SyncObject
Action	OnDirty
	Used internally to set owner NetworkBehaviour's dirty mask bit when changed. More...
Func< bool >	IsRecording = () => true
	Used internally to check if we are currently tracking changes. More...

Detailed Description

Definition at line 27 of file SyncVar.cs.

Constructor & Destructor Documentation

SyncVar()

Mirror.SyncVar< T >.SyncVar

(

T

value

)

Definition at line 93 of file SyncVar.cs.

        {
            // recommend explicit GameObject, NetworkIdentity, NetworkBehaviour
            // with persistent netId method
            if (this is SyncVar<GameObject>)
                Debug.LogWarning($"Use explicit {nameof(SyncVarGameObject)} class instead of {nameof(SyncVar<T>)}<GameObject>. It stores netId internally for persistence.");
 
            if (this is SyncVar<NetworkIdentity>)
                Debug.LogWarning($"Use explicit {nameof(SyncVarNetworkIdentity)} class instead of {nameof(SyncVar<T>)}<NetworkIdentity>. It stores netId internally for persistence.");
 
            if (this is SyncVar<NetworkBehaviour>)
                Debug.LogWarning($"Use explicit SyncVarNetworkBehaviour class instead of {nameof(SyncVar<T>)}<NetworkBehaviour>. It stores netId internally for persistence.");
 
            _Value = value;
        }

Member Function Documentation

ClearChanges()

override void Mirror.SyncVar< T >.ClearChanges ( )

virtual

Discard all the queued changes

Implements Mirror.SyncObject.

Definition at line 88 of file SyncVar.cs.

{}

OnDeserializeAll()

override void Mirror.SyncVar< T >.OnDeserializeAll ( NetworkReader  reader )

virtual

Reads a full copy of the object

Implements Mirror.SyncObject.

OnDeserializeDelta()

override void Mirror.SyncVar< T >.OnDeserializeDelta ( NetworkReader  reader )

virtual

Reads the changes made to the object since last sync

Implements Mirror.SyncObject.

OnSerializeAll()

override void Mirror.SyncVar< T >.OnSerializeAll ( NetworkWriter  writer )

virtual

Write a full copy of the object

Implements Mirror.SyncObject.

OnSerializeDelta()

override void Mirror.SyncVar< T >.OnSerializeDelta ( NetworkWriter  writer )

virtual

Write the changes made to the object since last sync

Implements Mirror.SyncObject.

Reset()

override void Mirror.SyncVar< T >.Reset ( )

virtual

Resets the SyncObject so that it can be re-used

Implements Mirror.SyncObject.

Definition at line 89 of file SyncVar.cs.

{}

Property Documentation

Value

virtual T Mirror.SyncVar< T >.Value

getset

Definition at line 35 of file SyncVar.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _Value;
            set
            {
                // only if value changed. otherwise don't dirty/hook.
                // we have .Equals(T), simply reuse it here.
                if (!Equals(value))
                {
                    // set value, set dirty bit
                    T old = _Value;
                    _Value = value;
                    OnDirty();
 
                    // Value.set calls the hook if changed.
                    // calling Value.set from within the hook would call the
                    // hook again and deadlock. prevent it with hookGuard.
                    // (see test: Hook_Set_DoesntDeadlock)
                    if (!hookGuard &&
                        // original [SyncVar] only calls hook on clients.
                        // let's keep it for consistency for now
                        // TODO remove check & dependency in the future.
                        //      use isClient/isServer in the hook instead.
                        NetworkClient.active)
                    {
                        hookGuard = true;
                        InvokeCallback(old, value);
                        hookGuard = false;
                    }
                }
            }
        }

Event Documentation

Callback

Action<T, T> Mirror.SyncVar< T >.Callback

Definition at line 74 of file SyncVar.cs.