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!
- WASD or Left stick: Move character
- Hold Shift or Shoulder button left: Run
- Spacebar or Joypad button down: Jump
Upon connecting, the
PlayerHandlerscript (attached to the PlayerHandler GameObject) creates a new instance of the character Prefab, located in the
Prefabs/Charactersfolder. When disconnecting, the same script destroys the instance created.
A local player meets a network-instantiated player.
coherence takes care of keeping all Game Clients in sync regarding network entities. When another Client connects, a new instance of your game character is instantiated in their scene, and a copy of their character is instantiated into yours. This is called network instantiation.
Now you can move and jump around, and you will see other characters move too.
You can see what is synced over the network by selecting the Prefab asset, and opening coherence's Configuration window (either by clicking on the Configure button on the
CoherenceSynccomponent, or by going to coherence > GameObject setup > Configure).
When this window opens on the first tab you will notice that, at the very top,
The Variables tab of the Configuration window.
Are you wondering why the position is checked by default? You'll find answers in the lesson regarding LiveQueries.
This is the data being transferred over the network. Each Client sends position and rotation of the character 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
Transformcomponent of their own instance of the remote player character.
To ensure that Clients don't modify properties of entities they don't have authority on, some components are either disabled or changed on instances that are non-authoritative. If you open the third tab of the Configuration window, you will see that 3 components are modified:
The Components tab of the Configuration window.
KinematicMovescripts are disabled.
Rigidbodycomponent is made kinematic.
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, each one will have 2 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, the name of a GameObject and the icon next to it informs you about its current authority state (see image).
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 this 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.
Blue = local, Orange = remote, the rest are non-networked objects.