SDK 1.1
Ask or search…
K
Links

1. Basic syncing

This scene demonstrates the simplest networking scenario possible with coherence. Characters sync their position and rotation, which immediately creates a feeling of presence. Someone else is connected!
Topics covered
Game controls
CoherenceSync | Bindings | Component behaviours | Authority
  • WASD or Left stick: Move character
  • Hold Shift or Shoulder button left: Run
  • Spacebar or Joypad button down: Jump

In this scene

Upon connecting, a script instantiates a character for you. Now you can move and jump around, and you will see other characters move too.
To be able to connect, you need to also run a local Replication Server, that can be started via coherence > Local Replication Server > Run for Worlds.
A local player meets a network-instantiated player.
coherence takes care of keeping network entities in sync on all Clients. When another Client connects, an instance of your character is instantiated in their scene, and an instance of their character is instantiated into yours. We refer to this as network instantiation.

How it's set up

When you click Connect in the sample UI, the CoherenceBridge opens a connection. The PlayerHandler GameObject on the root of the hierarchy controls character instantiation by responding to that connection event.
coherenceBridge connects, PlayerHandler responds.
Its PlayerHandler script implements something like this:
// PlayerHandler.cs
// Listen to CoherenceBridge events
private void Awake()
{
_bridge = FindObjectOfType<CoherenceBridge>();
_bridge.onConnected.AddListener(OnConnection);
_bridge.onDisconnected.AddListener(OnDisconnection);
}
// Handle local player lifetime, in response to connection events
private void OnConnection(CoherenceBridge bridge) => SpawnPlayer();
private void OnDisconnection(CoherenceBridge bridge, ConnectionCloseReason reason) => DespawnPlayer();
private void SpawnPlayer()
{
_player = Instantiate(prefabToSpawn, initialPosition, Quaternion.identity);
}
private void DespawnPlayer()
{
Destroy(_player);
}
On connection, a character is created. On disconnection, the same script destroys the character's instance. Note how instantiating and removing a network entity is done just with regular Unity Instantiate and Destroy.
Now let's take a look at the Prefab that is being instantiated. You can find it in the /Prefabs/Characters folder.
By opening coherence's Configuration window (either by clicking on the Configure button on the CoherenceSync component, or by going to coherence > GameObject Setup > Configure), you can see what is synced over the network.
When this window opens on the Variables tab you will notice that, at the very top, Transform.position and Transform.rotation are checked:
The Variables tab of the Configuration window.
This is the data being transferred over the network for this object. Each Client sends the position and rotation of the character that they have authority over to every other connected Client, every time there is a change to it that is significant enough. We call these bindings.
Each connected Client receives these values and applies them to the Transform component of their own instance of the remote player character.

Component Actions

To ensure that Clients don't modify the properties of entities they don't have authority over, we need to make sure that they are not running on the character instances that are non-authoritative.
coherence offers a rapid way to make this happen. If you open the Components tab of the Configuration window, you will see that 3 components are configured to do something special:
The Components tab of the Configuration window.
In particular:
  • The PlayerInput and KinematicMove scripts get disabled.
  • The Rigidbody component is made kinematic.
While in Play Mode, try selecting a remote player character. You will notice that some of its script have been disabled by coherence:
Player Input and Move have been disabled.
You can learn more about Component Actions here.

Understanding authority

One important concept to get familiar with is the fact that every networked entity exists as a GameObject on every Client currently connected. However, only one of them has what we call authority over the network entity, and can control its synced variables.
For instance, if we play this scene with two Clients connected, each one will have 2 player instances in their respective worlds:
A local player character in one Client exists as a remote character on another Client.
This is something to keep in mind as you decide which components have to keep running or be disabled on remote instances, in order to not have the same code running unnecessarily on various Clients. This could create a conflict or put the two GameObjects in a very different state, generating unwanted results.
In the Unity Editor, when connected, the name of a GameObject and the icon next to it informs you about its current authority state (see image above).
There are two types of authority in coherence: State and Input. For the sake of simplicity, in this project we often refer just to a generic "authority", and what we mean is State authority. Go here for more info on authority.
If you want to see which entities are currently local and which ones are remote, we included a debug visualisation in the project. Hit the Tab key (or click the Joystick) to switch to a view that shows authority. You can keep playing the game while in this view, and see how things change (try the Physics scene!).
Blue = local, Orange = remote, the rest are non-networked objects.