State synchronization in Unity

Introduction

State synchronization keeps game data the same for all players in a multiplayer game. It helps everyone see the same game world at the same time.

When you want all players to see the same player positions in a multiplayer game.

When you need to share health or score updates between players.

When objects in the game world must move or change the same way for everyone.

When you want to keep game events like shooting or item pickups consistent across players.

Syntax

Unity

using Unity.Netcode;

public class PlayerState : NetworkBehaviour
{
    public NetworkVariable<Vector3> Position = new NetworkVariable<Vector3>();

    void Update()
    {
        if (IsOwner)
        {
            Position.Value = transform.position;
        }
        else
        {
            transform.position = Position.Value;
        }
    }
}

NetworkVariable is used to share data automatically between server and clients.

IsOwner checks if this player controls the object to send updates only from the owner.

Examples

This shares the player's health starting at 100 with all players.

Unity

public NetworkVariable<int> Health = new NetworkVariable<int>(100);

Only the server changes the score to keep it consistent.

Unity

if (IsServer)
{
    Score.Value += 10;
}

Clients update their object position to match the synchronized value.

Unity

transform.position = Position.Value;

Sample Program

This script syncs the position of a game object across the network. The owner sends its position, and others update to match.

Unity

using Unity.Netcode;
using UnityEngine;

public class SimpleSync : NetworkBehaviour
{
    public NetworkVariable<Vector3> syncedPosition = new NetworkVariable<Vector3>();

    void Update()
    {
        if (IsOwner)
        {
            syncedPosition.Value = transform.position;
        }
        else
        {
            transform.position = syncedPosition.Value;
        }
    }
}

Important Notes

Always update NetworkVariables only from the owner or server to avoid conflicts.

NetworkVariables automatically send updates, so you don't need to write extra code for syncing.

Test multiplayer syncing using Unity's Play Mode with multiple clients to see synchronization in action.

Summary

State synchronization shares game data between players to keep the game world consistent.

Use NetworkVariables to automatically sync data like position or health.

Only the owner or server should update the shared state to avoid errors.

Practice

1. What is the main purpose of state synchronization in Unity multiplayer games?

easy

A. To create new game levels automatically

B. To improve graphics quality

C. To speed up the game loading time

D. To keep game data consistent for all players

Solution

1. Step 1: Understand the role of state synchronization

   State synchronization ensures that all players see the same game data, like positions and health.

2. Step 2: Identify the correct purpose

   Keeping data consistent for all players is the key goal of state synchronization.

3. Final Answer:

   To keep game data consistent for all players -> Option D

4. Quick Check:

   State synchronization = consistent data [OK]

Hint: Think: same game info for everyone [OK]

Common Mistakes:

• Confusing synchronization with graphics or loading speed
• Thinking it creates new content automatically

2. Which of the following is the correct way to declare a NetworkVariable for player health in Unity?

easy

A. public NetworkVariable<int> playerHealth = new NetworkVariable<int>(100);

B. NetworkVariable playerHealth = 100;

C. int playerHealth = new NetworkVariable<int>();

D. public int playerHealth = NetworkVariable<int>(100);

Solution

1. Step 1: Recall NetworkVariable declaration syntax

   NetworkVariable must be declared with type and initialized properly, like new NetworkVariable<int>(initialValue).

2. Step 2: Check each option

   public NetworkVariable<int> playerHealth = new NetworkVariable<int>(100); correctly declares and initializes playerHealth as a NetworkVariable of int with 100.

3. Final Answer:

   public NetworkVariable<int> playerHealth = new NetworkVariable<int>(100); -> Option A

4. Quick Check:

   Correct NetworkVariable syntax = public NetworkVariable<int> playerHealth = new NetworkVariable<int>(100); [OK]

Hint: Look for 'new NetworkVariable<Type>(value)' pattern [OK]

Common Mistakes:

• Assigning value directly without NetworkVariable
• Missing 'new' keyword or type in declaration

3. Given this code snippet in a Unity multiplayer game, what will be the output if the owner updates the position?

public NetworkVariable<Vector3> playerPosition = new NetworkVariable<Vector3>(Vector3.zero);

void UpdatePosition(Vector3 newPos) {
    if (IsOwner) {
        playerPosition.Value = newPos;
    }
    Debug.Log(playerPosition.Value);
}

medium

A. Always Vector3.zero

B. The new position value passed to UpdatePosition

C. Null reference error

D. The previous position before update

Solution

1. Step 1: Understand owner update behavior

   Only the owner can update the NetworkVariable value, so playerPosition.Value changes to newPos.

2. Step 2: Check what Debug.Log prints

   Debug.Log prints the current value of playerPosition, which is updated to newPos by the owner.

3. Final Answer:

   The new position value passed to UpdatePosition -> Option B

4. Quick Check:

   Owner updates value = new position logged [OK]

Hint: Owner changes value, so output matches newPos [OK]

Common Mistakes:

• Thinking value stays zero after update
• Expecting error due to NetworkVariable usage
• Assuming non-owner can update value

4. Identify the error in this Unity state synchronization code snippet:

public NetworkVariable<int> score = new NetworkVariable<int>(0);

void UpdateScore(int points) {
    score.Value += points;
}

medium

A. Missing type declaration for score

B. Incorrect NetworkVariable initialization

C. Updating NetworkVariable without checking ownership

D. Using += operator on NetworkVariable directly

Solution

1. Step 1: Review NetworkVariable update rules

   NetworkVariables should only be updated by the owner or server to avoid conflicts.

2. Step 2: Check code for ownership check

   The code updates score.Value without verifying if the caller is the owner, which can cause sync issues.

3. Final Answer:

   Updating NetworkVariable without checking ownership -> Option C

4. Quick Check:

   Always check ownership before updating NetworkVariable [OK]

Hint: Always verify ownership before changing NetworkVariable [OK]

Common Mistakes:

• Forgetting ownership check before update
• Assuming NetworkVariable updates are automatic
• Confusing syntax errors with logic errors

5. You want to synchronize a player's inventory (a list of strings) across the network in Unity. Which approach correctly applies state synchronization principles?

hard

A. Use a NetworkList<string> updated only by the owner, syncing changes automatically

B. Use a regular List<string> and update it on all clients manually

C. Use a NetworkVariable and update it from any client freely

D. Send inventory data as strings via RPC every frame without ownership checks

Solution

1. Step 1: Identify the correct data structure for lists

   NetworkList is designed for syncing collections like lists automatically in Unity.

2. Step 2: Apply ownership update rule

   Only the owner should update the NetworkList to keep data consistent and avoid conflicts.

3. Final Answer:

   Use a NetworkList<string> updated only by the owner, syncing changes automatically -> Option A

4. Quick Check:

   NetworkList + owner updates = correct sync [OK]

Hint: Use NetworkList and update only as owner [OK]

Common Mistakes:

• Using regular List without network sync
• Updating NetworkVariable<List> from any client
• Sending data every frame without ownership checks