Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

SyncVarAttribute

class in UnityEngine.Networking

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

[SyncVar] is an attribute that can be put on member variables of NetworkBehaviour classes. These variables will have their values sychronized from the server to clients in the game that are in the ready state.

Setting the value of a [SyncVar] marks it as dirty, so it will be sent to clients at the end of the current frame. Only simple values can be marked as [SyncVars]. The type of the SyncVar variable cannot be from an external DLL or assembly.

using UnityEngine;
using UnityEngine.Networking;

public class Ship : NetworkBehaviour { [SyncVar] public int health = 100;

[SyncVar] public float energy = 100; }

The allowed SyncVar types are;

• Basic type (byte, int, float, string, UInt64, etc)
• Built-in Unity math type (Vector3, Quaternion, etc),
• Structs containing allowable types .

Properties

hookThe hook attribute can be used to specify a function to be called when the sync var changes value on the client.

Did you find this page useful? Please give it a rating: