Namespace Unity.Netcode

Classes

AnticipatedNetworkVariable<T>

A variable that can be synchronized over the network. This version supports basic client anticipation - the client can set a value on the belief that the server will update it to reflect the same value in a future update (i.e., as the result of an RPC call). This value can then be adjusted as new updates from the server come in, in three basic modes:

Snap: In this mode (with StaleDataHandling set to Ignore and no OnReanticipate(double) callback), the moment a more up-to-date value is received from the authority, it will simply replace the anticipated value, resulting in a "snap" to the new value if it is different from the anticipated value.
Smooth: In this mode (with StaleDataHandling set to Ignore and an OnReanticipate(double) callback that calls Smooth(in T, in T, float, SmoothDelegate) from the anticipated value to the authority value with an appropriate Lerp(float, float, float)-style smooth function), when a more up-to-date value is received from the authority, it will interpolate over time from an incorrect anticipated value to the correct authoritative value.
Constant Reanticipation: In this mode (with StaleDataHandling set to Reanticipate and an OnReanticipate(double) that calculates a new anticipated value based on the current authoritative value), when a more up-to-date value is received from the authority, user code calculates a new anticipated value, possibly calling Smooth(in T, in T, float, SmoothDelegate) to interpolate between the previous anticipation and the new anticipation. This is useful for values that change frequently and need to constantly be re-evaluated, as opposed to values that change only in response to user action and simply need a one-time anticipation when the user performs that action.

Note that these three modes may be combined. For example, if an OnReanticipate(double) callback does not call either Smooth(in T, in T, float, SmoothDelegate) or Anticipate(T), the result will be a snap to the authoritative value, enabling for a callback that may conditionally call Smooth(in T, in T, float, SmoothDelegate) when the difference between the anticipated and authoritative values is within some threshold, but fall back to snap behavior if the difference is too large.

Arithmetic

Arithmetic helper class

BaseRpcTarget

BitCounter

Utility class to count the number of bytes or bits needed to serialize a value.

BufferedLinearInterpolatorFloat

Solves for incoming values that are jittered Partially solves for message loss. Unclamped lerping helps hide this, but not completely

BufferedLinearInterpolatorQuaternion

Solves for incoming values that are jittered Partially solves for message loss. Unclamped lerping helps hide this, but not completely

BufferedLinearInterpolatorVector3

BufferedLinearInterpolator<T>

Solves for incoming values that are jittered Partially solves for message loss. Unclamped lerping helps hide this, but not completely

BytePacker

Utility class for packing values in serialization. ByteUnpacker to unpack packed values.

ByteUnpacker

Byte Unpacking Helper Class Use this class to unpack values during deserialization for values that were packed. BytePacker to pack unpacked values

ClientRpcAttribute

Marks a method as ClientRpc.

A ClientRpc marked method will be fired by the server but executed on clients.

CustomMessagingManager

The manager class to manage custom messages, note that this is different from the NetworkManager custom messages. These are named and are much easier to use.

GenerateSerializationForGenericParameterAttribute

Marks a generic parameter in this class as a type that should be serialized through NetworkVariableSerialization<T>. This enables the use of the following methods to support serialization within a Network Variable type:

NetworkVariableSerialization<T>.Read(FastBufferReader, ref T)
NetworkVariableSerialization<T>.Write(FastBufferWriter, ref T)
NetworkVariableSerialization<T>.AreEqual
NetworkVariableSerialization<T>.Duplicate(in T, ref T)

The parameter is indicated by index (and is 0-indexed); for example:

[SerializesGenericParameter(1)]
public class MyClass<TTypeOne, TTypeTwo>
{
}

This tells the code generation for NetworkVariableSerialization<T> to generate serialized code for TTypeTwo (generic parameter 1).

Note that this is primarily intended to support subtypes of NetworkVariableBase, and as such, the type resolution is done by examining fields of NetworkBehaviour subclasses. If your type is not used in a NetworkBehaviour, the codegen will not find the types, even with this attribute.

This attribute is properly inherited by subclasses. For example:

[SerializesGenericParameter(0)]
public class MyClass<T>
{
}
public class MySubclass1 : MyClass<Foo>
{
}
public class MySubclass2<T> : MyClass<T>
{
}
[SerializesGenericParameter(1)]
public class MySubclass3<TTypeOne, TTypeTwo> : MyClass<TTypeOne>
{
}
public class MyBehaviour : NetworkBehaviour
{
public MySubclass1 TheValue;
public MySubclass2<Bar> TheValue;
public MySubclass3<Baz, Qux> TheValue;
}

The above code will trigger generation of serialization code for Foo (passed directly to the base class), Bar (passed indirectly to the base class), Baz (passed indirectly to the base class), and Qux (marked as serializable in the subclass).

GenerateSerializationForTypeAttribute

Specifies a specific type that needs serialization to be generated by codegen. This is only needed in special circumstances where manual serialization is being done. If you are making a generic network variable-style class, use GenerateSerializationForGenericParameterAttribute.

This attribute can be attached to any class or method anywhere in the codebase and will trigger codegen to generate serialization code for the provided type. It only needs to be included once type per codebase, but including it multiple times for the same type is safe.

InvalidChannelException

Exception thrown when a specified network channel is invalid

InvalidParentException

Exception thrown when the new parent candidate of the NetworkObject is not valid

NetworkBehaviour

The base class to override to write network code. Inherits MonoBehaviour

NetworkBehaviourUpdater

An helper class that helps NetworkManager update NetworkBehaviours and replicate them down to connected clients.

NetworkClient

A NetworkClient

NetworkConfig

The configuration object used to start server, client and hosts

NetworkConfigurationException

Exception thrown when a change to a configuration is wrong

NetworkConnectionManager

The NGO connection manager handles:

Client Connections
Client Approval
Processing NetworkEvents.
Client Disconnection

NetworkList<T>

Event based NetworkVariable container for syncing Lists

NetworkLog

Helper class for logging

NetworkManager

The main component of the library

NetworkManager.ConnectionApprovalResponse

Connection Approval Response

NetworkObject

A component used to identify that a GameObject in the network

NetworkPrefab

Class that represents a NetworkPrefab

NetworkPrefabHandler

Primary handler to add or remove customized spawn and destroy handlers for a network prefab (i.e. a prefab with a NetworkObject component) Register custom prefab handlers by implementing the INetworkPrefabInstanceHandler interface.

NetworkPrefabs

A class that represents the runtime aspect of network prefabs. This class contains processed prefabs from the NetworkPrefabsList, as well as additional modifications (additions and removals) made at runtime.

NetworkPrefabsList

A ScriptableObject for holding a network prefabs list, which can be shared between multiple NetworkManagers.

When NetworkManagers hold references to this list, modifications to the list at runtime will be picked up by all NetworkManagers that reference it.

NetworkSceneManager

Main class for managing network scenes when EnableSceneManagement is enabled. Uses the SceneEventMessage message to communicate SceneEventData between the server and client(s)

NetworkSpawnManager

Class that handles object spawning

NetworkTickSystem

Provides discretized time. This is useful for games that require ticks happening at regular interval on the server and clients.

NetworkTimeSystem

NetworkTimeSystem is a standalone system which can be used to run a network time simulation. The network time system maintains both a local and a server time. The local time is based on the server time as last received from the server plus an offset based on the current RTT - in other words, it is a best-guess effort at predicting what the server tick will be when a given network action is processed on the server.

NetworkTransport

The generic transport class all Netcode for GameObjects network transport implementations derive from. Use this class to add a custom transport. for an example of how a transport is integrated

NetworkUpdateLoop

Represents the network update loop injected into low-level player loop in Unity.

NetworkVariableBase

Interface for network value containers

NetworkVariableSerializationTypes

This class contains initialization functions for various different types used in NetworkVariables. Generally speaking, these methods are called by a module initializer created by codegen (NetworkBehaviourILPP) and do not need to be called manually.

There are two types of initializers: Serializers and EqualityCheckers. Every type must have an EqualityChecker registered to it in order to be used in NetworkVariable; however, not all types need a Serializer. Types without a serializer registered will fall back to using the delegates in UserNetworkVariableSerialization<T>. If no such delegate has been registered, a type without a serializer will throw an exception on the first attempt to serialize or deserialize it. (Again, however, codegen handles this automatically and this registration doesn't typically need to be performed manually.)

NetworkVariableSerialization<T>

Support methods for reading/writing NetworkVariables Because there are multiple overloads of WriteValue/ReadValue based on different generic constraints, but there's no way to achieve the same thing with a class, this sets up various read/write schemes based on which constraints are met by T using reflection, which is done at module load time.

NetworkVariable<T>

A variable that can be synchronized over the network.

NotListeningException

Exception thrown when the operation require NetworkManager to be listening.

NotServerException

Exception thrown when the operation can only be done on the server

PendingClient

Server-Side Only: A class representing a client that is currently in the process of connecting

QuaternionCompressor

A Smallest Three Quaternion Compressor Implementation

RpcAttribute

Represents the common base class for Rpc attributes.

RpcException

RpcTarget

Implementations of the various SendTo options, as well as additional runtime-only options Single(ulong, RpcTargetUse), Group(NativeArray<ulong>), Group(NativeList<ulong>), Group(ulong[]), Group<T>(T), Not(ulong), Not(NativeArray<ulong>), Not(NativeList<ulong>), Not(ulong[]), and Not<T>(T)

SceneEvent

Used for local notifications of various scene events. The OnSceneEvent of delegate type NetworkSceneManager.SceneEventDelegate uses this class to provide scene event status.
Note: This is only when EnableSceneManagement is enabled.
*** Do not start new scene events within scene event notification callbacks.
See also:
SceneEventType

ServerRpcAttribute

Marks a method as ServerRpc.

A ServerRpc marked method will be fired by a client but executed on the server.

SpawnStateException

Exception thrown when an object is not yet spawned

TestingNetworkTransport

UserNetworkVariableSerialization<T>

This class is used to register user serialization with NetworkVariables for types that are serialized via user serialization, such as with FastBufferReader and FastBufferWriter extension methods. Finding those methods isn't achievable efficiently at runtime, so this allows users to tell NetworkVariable about those extension methods (or simply pass in a lambda)

VisibilityChangeException

Exception thrown when a visibility change fails

Structs

BitReader

Helper class for doing bitwise reads for a FastBufferReader. Ensures all bitwise reads end on proper byte alignment so FastBufferReader doesn't have to be concerned with misaligned reads.

BitWriter

Helper class for doing bitwise writes for a FastBufferWriter. Ensures all bitwise writes end on proper byte alignment so FastBufferWriter doesn't have to be concerned with misaligned writes.

BufferSerializer<TReaderWriter>

Two-way serializer wrapping FastBufferReader or FastBufferWriter.

Implemented as a ref struct to help enforce the requirement that the BufferSerializer cannot outlive the FBR/FBW it wraps or using it will cause a crash

BufferSerializer doesn't wrap FastBufferReader or FastBufferWriter directly because it can't. ref structs can't implement interfaces, and in order to be able to have two different implementations with the same interface (which allows us to avoid an "if(IsReader)" on every call), the thing directly wrapping the struct has to implement an interface. So IReaderWriter exists as the interface, which is implemented by a normal struct, while the ref struct wraps the normal one to enforce the two above requirements. (Allowing direct access to the IReaderWriter struct would allow dangerous things to happen because the struct's lifetime could outlive the Reader/Writer's.)

ClientRpcParams

Client-Side RPC Can be used with any client-side remote procedure call Note: Typically this is used primarily for sending to a specific list of clients as opposed to the default (all). ClientRpcSendParams

ClientRpcReceiveParams

Client-Side RPC Place holder. ServerRpcParams Note: Server will always be the sender, so this structure is a place holder

ClientRpcSendParams

Client-Side RPC The send parameters, when sending client RPCs, provides you wil the ability to target specific clients as a managed or unmanaged list: TargetClientIds and TargetClientIdsNativeArray

ConnectionEventData

Returned as a parameter of the OnConnectionEvent event notification.

FastBufferReader

Optimized class used for reading values from a byte stream FastBufferWriter BytePacker ByteUnpacker

FastBufferWriter

Optimized class used for writing values into a byte stream FastBufferReader BytePacker ByteUnpacker

FastBufferWriter.ForEnums

This empty struct exists to allow overloading WriteValue based on generic constraints. At the bytecode level, constraints aren't included in the method signature, so if multiple methods exist with the same signature, it causes a compile error because they would end up being emitted as the same method, even if the constraints are different. Adding an empty struct with a default value gives them different signatures in the bytecode, which then allows the compiler to do overload resolution based on the generic constraints without the user having to pass the struct in themselves.

FastBufferWriter.ForFixedStrings

FastBufferWriter.ForGeneric

FastBufferWriter.ForNetworkSerializable

FastBufferWriter.ForPrimitives

FastBufferWriter.ForStructs

ForceNetworkSerializeByMemcpy<T>

This is a wrapper that adds INetworkSerializeByMemcpy support to existing structs that the developer doesn't have the ability to modify (for example, external structs like Guid).

NetworkBehaviourReference

A helper struct for serializing NetworkBehaviours over the network. Can be used in RPCs and NetworkVariable<T>. Network IDs get recycled by the NetworkManager after a while, so using a NetworkBehaviourReference for too long may result in a different NetworkBehaviour being returned for the assigned NetworkBehaviourId. NetworkBehaviourReferences are best for short-term use when receieved via RPC or custom message, rather than for long-term references to NetworkBehaviours.

NetworkListEvent<T>

Struct containing event information about changes to a NetworkList.

NetworkManager.ConnectionApprovalRequest

Connection Approval Request

NetworkObjectReference

A helper struct for serializing NetworkObjects over the network. Can be used in RPCs and NetworkVariable<T>.

NetworkTime

A struct to represent a point of time in a networked game. Time is stored as a combination of amount of passed ticks + a duration offset. This struct is meant to replace the Unity Time API for multiplayer gameplay.

NetworkVariableUpdateTraits

RpcAttribute.RpcAttributeParams

RpcParams

Server-Side RPC Can be used with any sever-side remote procedure call Note: typically this is use primarily for the ServerRpcReceiveParams

RpcReceiveParams

The receive parameters for server-side remote procedure calls

RpcSendParams

Generic RPC

ServerRpcParams

Server-Side RPC Can be used with any sever-side remote procedure call Note: typically this is use primarily for the ServerRpcReceiveParams

ServerRpcReceiveParams

The receive parameters for server-side remote procedure calls

ServerRpcSendParams

Server-Side RPC Place holder. ServerRpcParams Note: Clients always send to one destination when sending RPCs to the server so this structure is a place holder

Interfaces

INetworkPrefabInstanceHandler

Interface for customizing, overriding, spawning, and destroying Network Prefabs Used by NetworkPrefabHandler

INetworkSerializable

Interface for implementing custom serializable types.

INetworkSerializeByMemcpy

This interface is a "tag" that can be applied to a struct to mark that struct as being serializable by memcpy. It's up to the developer of the struct to analyze the struct's contents and ensure it is actually serializable by memcpy. This requires all of the members of the struct to be unmanaged Plain-Old-Data values - if your struct contains a pointer (or a type that contains a pointer, like NativeList<T>), it should be serialized via INetworkSerializable or via FastBufferReader/FastBufferWriter extension methods.

INetworkUpdateSystem

Defines the required interface of a network update system being executed by the NetworkUpdateLoop.

IReaderWriter

Interface for an implementation of one side of a two-way serializer

Enums

ConnectionEvent

The connection event type set within ConnectionEventData to signify the type of connection event notification received.

HashSize

Represents the length of a var int encoded hash Note that the HashSize does not say anything about the actual final output due to the var int encoding It just says how many bytes the maximum will be

LocalDeferMode

LogLevel

Log level

NetworkDelivery

Delivery methods

NetworkEvent

Represents a netEvent when polling

NetworkListEvent<T>.EventType

Enum representing the different operations available for triggering an event.

NetworkPrefabOverride

The method of NetworkPrefab override used to identify the source prefab

NetworkUpdateStage

Defines network update stages being executed by the network update loop. See for more details on update stages: https://docs.unity3d.com/ScriptReference/PlayerLoop.Initialization.html

NetworkVariableReadPermission

The permission types for reading a var

NetworkVariableWritePermission

The permission types for writing a var

PendingClient.State

The states of a connection

RpcDelivery

RPC delivery types

RpcTargetUse

This parameter configures a performance optimization. This optimization is not valid in all situations.
Because BaseRpcTarget is a managed type, allocating a new one is expensive, as it puts pressure on the garbage collector.

SceneEventProgressStatus

Used by NetworkSceneManager to determine if a server invoked scene event has started. The returned status is stored in the Status property.
Note: This was formally known as SwitchSceneProgress which contained the AsyncOperation. All AsyncOperations are now delivered by the OnSceneEvent event handler via the SceneEvent parameter.

SceneEventType

The different types of scene events communicated between a server and client.
Used by NetworkSceneManager for SceneEventMessage messages.
Note: This is only when EnableSceneManagement is enabled.
See also:
SceneEvent

SendTo

Configuration for the default method by which an RPC is communicated across the network

StaleDataHandling

Report a problem on this page

Namespace Unity.Netcode

Classes

Structs

Interfaces

Enums

Delegates