Struct NetworkProtocolVersion

The NetworkProtocolVersion is a singleton entity that is automatically created by the NetworkStreamReceiveSystem and that is used to verify client and server compatibility.

The protocol version is composed by different part:

- The NetCode package version.

- A user defined GameProtocolVersion game version, that identify the version of your game

- A unique hash of all the IRpcCommand and ICommandData that is used to verify both client and server recognize the same rpc and command and that can serialize/deserialize them in the same way

- A unique hash of all the replicated Unity.Entities.IComponentData and Unity.Entities.IBufferElementData that is used to verify both client and server can serialize/deserialize all the replicated component present in the ghosts

When a client tries to connect to the server, as part of the initial handshake, they exchange their protocol version to validate they are both using same version. If the version mismatch, the connection is forcibly closed.
Implements
IComponentData
IQueryTypeParameter
Inherited Members
Namespace: Unity.NetCode
Assembly: Unity.NetCode.dll
Syntax
public struct NetworkProtocolVersion : IComponentData, IQueryTypeParameter

Fields

ComponentCollectionVersion

A unique hash calculated on all the serialized components that can be used to check if the client can propertly decode the snapshots.

Declaration
public ulong ComponentCollectionVersion
Field Value
Type Description
ulong

GameVersion

The user specific game version the server and client are using. 0 by default, unless the GameProtocolVersion is used to customise it.

Declaration
public int GameVersion
Field Value
Type Description
int

NetCodeVersion

The NetCode package version

Declaration
public int NetCodeVersion
Field Value
Type Description
int

RpcCollectionVersion

A unique hash computed of all the RPC and commands, used to check if the server and client have the same messages and with compatible data and serialization.

Declaration
public ulong RpcCollectionVersion
Field Value
Type Description
ulong

k_NetCodeVersion

The integer used to determine a compatible version of the NetCode package.

Declaration
public const int k_NetCodeVersion = 1
Field Value
Type Description
int

Implements

Unity.Entities.IComponentData
Unity.Entities.IQueryTypeParameter

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