API Reference

AnimatorSyncPacket

Class NetBuff.Components.AnimatorSyncPacket

Info

Packet used to sync the state of an Animator component.

Implements

NetBuff.Interface.IOwnedPacket

Properties

Property	Accessors	Description
public Changes Change	Get Set	Represents the changes that have been made to the Animator.
public LayerInfo[] Layers	Get Set	Holds information about the layers that have been changed.
public float Speed	Get Set	The speed of the Animator.
public byte ChangedParameters	Get Set	The amount of parameters that have been changed.
public byte[] ParameterData	Get Set	Holds the data of the parameters that have been changed.
public NetworkId Id Overrides	Get Set	The id of the owner of the packet.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

AnimatorTriggerPacket

Class NetBuff.Components.AnimatorTriggerPacket

Info

Packet used to trigger an Animator trigger.

Implements

NetBuff.Interface.IOwnedPacket

Properties

Property	Accessors	Description
public int TriggerHash	Get Set	The hash of the trigger.
public NetworkId Id Overrides	Get Set	The id of the owner of the packet.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

BoolNetworkValue

Class NetBuff.Misc.BoolNetworkValue

Info

USed to store a boolean value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

ByteNetworkValue

Class NetBuff.Misc.ByteNetworkValue

Info

Used to store a byte value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

Changes

Enum NetBuff.Components.AnimatorSyncPacket.Changes

Info

Represents the changes that have been made to the Animator.

Enum Values

Value	Description
None	No changes have been made.
Layers	At least one layer have been changed.
Parameters	At least one parameter have been changed.
Speed	The speed of the Animator has been changed.

ClientOnlyAttribute

Class NetBuff.Misc.ClientOnlyAttribute

Info

Used to mark a method, field or property as client only.
This means that the method, field or property will only be used on the client side.

Color32NetworkValue

Class NetBuff.Misc.Color32NetworkValue

Info

Used to store a Color32 value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

ColorNetworkValue

Class NetBuff.Misc.ColorNetworkValue

Info

Used to store a Color value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

ConnectionEndMode

Enum NetBuff.NetworkTransport.ConnectionEndMode

Info

Enum for the connection end mode.

Enum Values

Value	Description
Shutdown	Connection end normally.
InternalError	Connection end with error.

CurrentGraph

Enum NetBuff.NetworkManagerGUI.CurrentGraph

Info

Used to choose the current rendered graph type.

Enum Values

Value	Description
None	No graph is rendered.
FPS	A graph for FPS is rendered.
Latency	A graph for Latency is rendered.
PacketSent	A graph for Packet Sent is rendered.
PacketReceived	A graph for Packet Received is rendered.
PacketLoss	A graph for Packet Loss is rendered.

DoubleNetworkValue

Class NetBuff.Misc.DoubleNetworkValue

Info

Used to store a double value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

EnvironmentType

Enum NetBuff.NetworkTransport.EnvironmentType

Info

Enum for the type of environment.

Enum Values

Value	Description
None	Network environment is not set.
Server	Network environment is server.
Host	Network environment is host (server and client).
Client	Network environment is client.

FloatNetworkValue

Class NetBuff.Misc.FloatNetworkValue

Info

Used to store a float value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

GraphPlotter

Class NetBuff.Misc.GraphPlotter

Info

Utility class for drawing graphs in Unity.
Used by NetworkManagerGUI to draw graphs of network statistics.

Methods

Method	Parameters	Description
public static void DrawGraph	float x float y int barWidth Color color int maxWidth IList<float> data float max float maxHeight	Draws a graph to display the given data. The position represents the bottom-left corner of the graph.

GraphPlotterData

Class NetBuff.Misc.GraphPlotter.GraphPlotterData

Info

Holds the data to be plotted on the graph.

Properties

Property	Accessors	Description
public IList<float> Data	Get	The data to be plotted.
public int Limit	Get Set	The maximum number of data points to be stored.
public float Max	Get Set	The maximum value of the data. Used to scale the graph.

Methods

Method	Parameters	Description
public void AddData	float toAdd bool changeMax = true	Adds a data point to the graph. If the number of data points exceeds the limit, the oldest data point is removed. If changeMax is true, the maximum value of the data is updated if the new data point is greater than the current maximum.
public void Clear		Clears all data points.

IClientConnectionInfo

Interface NetBuff.Interface.IClientConnectionInfo

Info

Holds a connection information along with the remote client id.

Implements

NetBuff.Interface.IConnectionInfo

Properties

Property	Accessors	Description
public int Id	Get	The id of the remote client.
public int Latency Overrides	Get	The latency of the connection (in milliseconds). Represents the RTT (Round Trip Time) of the connection.
public long PacketSent Overrides	Get	The number of packets sent through the connection.
public long PacketReceived Overrides	Get	The number of packets received through the connection.
public long PacketLoss Overrides	Get	The number of packets lost through the connection.
public long PacketLossPercentage Overrides	Get	The percentage of packet loss through the connection. It is calculated as PacketLoss * 100 / PacketSent. Float value between 0 and 100.

IConnectionInfo

Interface NetBuff.Interface.IConnectionInfo

Info

Holds a connection information

Properties

Property	Accessors	Description
public int Latency	Get	The latency of the connection (in milliseconds). Represents the RTT (Round Trip Time) of the connection.
public long PacketSent	Get	The number of packets sent through the connection.
public long PacketReceived	Get	The number of packets received through the connection.
public long PacketLoss	Get	The number of packets lost through the connection.
public long PacketLossPercentage	Get	The percentage of packet loss through the connection. It is calculated as PacketLoss * 100 / PacketSent. Float value between 0 and 100.

INetworkBehaviourSerializer

Interface NetBuff.Interface.INetworkBehaviourSerializer

Info

Interface for serializing and deserializing network behaviours additional data.
You can implement this interface in your network behaviour to send additional data over the network.

Methods

Method	Parameters	Description
public void OnSerialize	BinaryWriter writer bool forceSendAll	This method is called when the network behaviour is being serialized. If forceSendAll is true, all data should be sent, otherwise only dirty data should be sent. ForceSendAll will only be true when the server is sending data to a client for the first time.
public void OnDeserialize	BinaryReader reader	This method is called when the network behaviour is being deserialized.

IntNetworkValue

Class NetBuff.Misc.IntNetworkValue

Info

Used to store a int value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

IOwnedPacket

Interface NetBuff.Interface.IOwnedPacket

Info

Base interface for all owned packets.
Owned packets are packets that have an NetworkIdentity owner.
They will be sent through the network to the owner of the packet automatically.
Packets are used to send data between the server and the client.
They are serialized to bytes and deserialized from bytes to be sent over the network.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The id of the owner of the packet.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

IPacket

Interface NetBuff.Interface.IPacket

Info

Base interface for all packets.
Packets are used to send data between the server and the client.
They are serialized to bytes and deserialized from bytes to be sent over the network.

Methods

Method	Parameters	Description
public void Serialize	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize	BinaryReader reader	Deserializes the packet from a binary reader.

LayerInfo

Class NetBuff.Components.AnimatorSyncPacket.LayerInfo

Info

Holds information about a layer.

Properties

Property	Accessors	Description
public byte LayerIndex	Get Set	The index of the layer.
public int StateHash	Get Set	The hash of the current Animator state.
public float NormalizedTime	Get Set	The normalized time of the current Animator state.
public float LayerWeight	Get Set	The weight of the layer.

LocalNetworkTransport

Class NetBuff.Local.LocalNetworkTransport

Info

Used for local running, does not actually send packets over the network.
Can be used on Split Screen games or for testing.

Implements

NetBuff.NetworkTransport

Properties

Property	Accessors	Description
public int ClientCount	Get Set	The amount of clients that will be created when the host is started.

Methods

Method	Parameters	Description
public ServerDiscoverer GetServerDiscoverer Overrides		Returns a new discoverer that will be used to find available servers.
public void StartHost Overrides	int magicNumber	Starts the network transport as a host (server and client).
public void StartServer Overrides		Starts the network transport as a server.
public void StartClient Overrides	int magicNumber	Starts the network transport as a client.
public void Close Overrides		Closes the network transport.
public IClientConnectionInfo GetClientInfo Overrides	int id	Returns the connection information of the client with the given id.
public int GetClientCount Overrides		Returns the number of clients connected to the server.
public IEnumerable<IClientConnectionInfo> GetClients Overrides		Returns all the clients connected to the server.
public void ClientDisconnect Overrides	string reason	Disconnects the client from the server.
public void ServerDisconnect Overrides	int id string reason	Disconnects the client with the given id from the server.
public void ClientSendPacket Overrides	IPacket packet bool reliable = false	Sends a packet to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
public void ServerSendPacket Overrides	IPacket packet int target = -1 bool reliable = false	Sends a packet to the client with the given id. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered. If the target is -1, the packet will be sent to all clients connected to the server.

LongNetworkValue

Class NetBuff.Misc.LongNetworkValue

Info

Used to store a long value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

ModifierType

Enum NetBuff.Misc.NetworkValue.ModifierType

Info

Used to determine who can modify a value.

Enum Values

Value	Description
OwnerOnly	Only the owner of the behaviour that this value is attached to can modify it.
Server	Only the server can modify it.
Everybody	Everybody can modify it.

NetworkAction

Class NetBuff.Misc.NetworkAction

Info

Main class for network actions. Should be used to register and invoke network actions

Properties

Property	Accessors	Description
public static NetworkActionListener<NetworkId,NetworkIdentity> OnObjectSpawn	Get	Called when a object is spawned
public static NetworkActionListener<NetworkId,NetworkIdentity> OnObjectDespawn	Get	Called when a object is despawned
public static NetworkActionListener<NetworkId,NetworkIdentity> OnObjectChangeOwner	Get	Called when a object owner is changed
public static NetworkActionListener<NetworkId,NetworkIdentity> OnObjectChangeActive	Get	Called when a object active state is changed
public static NetworkActionListener<NetworkId,NetworkIdentity> OnObjectSceneChanged	Get	Called when a object scene is changed
public static NetworkActionListener<string,int> OnSceneLoaded	Get	Called when a scene is loaded
public static NetworkActionListener<string,int> OnSceneUnloaded	Get	Called when a scene is unloaded

Methods

Method	Parameters	Description
public static void ClearAll		Clear all network actions

NetworkAction<T,TR>

Class NetBuff.Misc.NetworkAction<T,TR>

Info

Used as callback for network actions

Properties

Property	Accessors	Description
public T Value	Get Set	Holds the value of the network action

Methods

then

Method	Parameters	Description
public void Then	Action
Set the callback for the network action
public void Invoke	TR result	Invoke the network action

NetworkActionListener<T,TR>

Class NetBuff.Misc.NetworkActionListener<T,TR>

Info

Base class for network actions listeners

Methods

Method	Parameters	Description
public void Register	T key NetworkAction action bool temp	Register a network action
public void Remove	T key NetworkAction action	Remove a network action
public void Invoke	T key TR result	Invoke all registered network action. Clears all temporary actions
public void Clear		Clear all registred network actions

NetworkAnimator

Class NetBuff.Components.NetworkAnimator

Info

Syncs the state of an Animator component over the network, including parameters, layers, speed and time

Implements

NetBuff.Components.NetworkBehaviour

NetBuff.Interface.INetworkBehaviourSerializer

Properties

Property	Accessors	Description
public int TickRate	Get Set	Determines the tick rate of the NetworkAnimator. When set to -1, the default tick rate of the NetworkManager will be used.
public Animator Animator	Get	The Animator component to sync.

Methods

Method	Parameters	Description
public void SetTrigger	int triggerHash	Sets a trigger on the Animator component.
public void SetTrigger	string triggerName	Sets a trigger on the Animator component.
public float GetFloat	string name	Gets the value of the specified parameter.
public void SetFloat	string name float value	Sets the value of the specified parameter.
public float GetFloat	int nameHash	Gets the value of the specified parameter.
public void SetFloat	int nameHash float value	Sets the value of the specified parameter.
public bool GetBool	string name	Gets the value of the specified parameter.
public void SetBool	string name bool value	Sets the value of the specified parameter.
public bool GetBool	int nameHash	Gets the value of the specified parameter.
public void SetBool	int nameHash bool value	Sets the value of the specified parameter.
public int GetInteger	string name	Gets the value of the specified parameter.
public void SetInteger	string name int value	Sets the value of the specified parameter.
public int GetInteger	int nameHash	Gets the value of the specified parameter.
public void SetInteger	int nameHash int value	Sets the value of the specified parameter.
public void OnSpawned Overrides	bool isRetroactive	Called when this object is spawned on the network. Called when the network environment initializes if the object already exists. The isRetroactive parameter is true if the client is joining the server after the object is already spawned.
public void OnServerReceivePacket Overrides	IOwnedPacket packet int clientId	Called when the server receives a packet owned by this object from a client
public void OnClientReceivePacket Overrides	IOwnedPacket packet	Called when the clients receive a packet owned by this object from the server.
public void OnSerialize Overrides	BinaryWriter writer bool forceSendAll	This method is called when the network behaviour is being serialized. If forceSendAll is true, all data should be sent, otherwise only dirty data should be sent. ForceSendAll will only be true when the server is sending data to a client for the first time.
public void OnDeserialize Overrides	BinaryReader reader	This method is called when the network behaviour is being deserialized.

NetworkBehaviour

Class NetBuff.Components.NetworkBehaviour

Info

Base class for all network behaviours.
NetworkBehaviours cannot be added / removed at runtime.

Properties

Property	Accessors	Description
public byte BehaviourId	Get	The behaviour id of this behaviour (Relative to the identity).
public bool IsDirty	Get	Whether this behaviour has any dirty values that needs to be synchronized.
public ReadOnlySpan<NetworkValue> Values	Get	The values attached to this behaviour.
public NetworkIdentity Identity	Get	The network identity which this behaviour is attached to.
public NetworkId Id	Get	The network id of this behaviour identity.
public int OwnerId	Get	The owner id of this behaviour identity. If the owner id is -1, the object is owned by the server.
public NetworkId PrefabId	Get	The id of the prefab used to spawn this behaviour identity object. If the prefab id is empty, the object was not spawned from a prefab at runtime.
public bool HasAuthority	Get	Checks if the local environment has authority over this behaviour.
public bool IsOwnedByClient	Get	Checks if this behaviour identity is owned by any client.
public int SceneId	Get	The if of the scene this behaviour identity is in.
public static bool IsServer	Get	Checks if the local environment is the server.
public static int LoadedSceneCount	Get	The number of currently loaded scenes on the network.
public static string MainScene	Get	The name of the scene where the NetworkManager is currently in.
public static string LastLoadedScene	Get	The name of the currently last loaded scene.

Methods

Method	Parameters	Description
Server public void OnServerReceivePacket	IOwnedPacket packet int clientId	Called when the server receives a packet owned by this object from a client
Client public void OnClientReceivePacket	IOwnedPacket packet	Called when the clients receive a packet owned by this object from the server.
public void OnSpawned	bool isRetroactive	Called when this object is spawned on the network. Called when the network environment initializes if the object already exists. The isRetroactive parameter is true if the client is joining the server after the object is already spawned.
public void OnSceneChanged	int fromScene int toScene	Called when this object is moved to another scene.
Server public void OnClientConnected	int clientId	Called when a new client connects to the server.
Server public void OnClientDisconnected	int clientId	Called when a client disconnects from the server.
public void OnDespawned		Called when this object is despawned from the network.
public void OnActiveChanged	bool active	Called when the active state of this object changes. Called when the object is spawned as well.
public void OnOwnershipChanged	int oldOwner int newOwner	Called when the owner of this object changes.
public void OnSceneLoaded	int sceneId	Called when a new scene is loaded.
public void OnSceneUnloaded	int sceneId	Called when a loaded scene is unloaded.
public void OnAnyObjectSpawned	NetworkIdentity identity bool isRetroactive	Called when a new object is spawned on the network. The isRetroactive parameter is true if the client is joining the server after the object is already spawned.
public void WithValues	NetworkValue[] values	Attaches the given values to this behaviour. Shall not be called after the behaviour is spawned.
public void MarkSerializerDirty		Marks the serializer of this behaviour as dirty, so it will be synchronized through the network. Only call this method if the behaviour implements INetworkBehaviourSerializer.
public void UpdateDirtyValues		Synchronizes the dirty values of this behaviour through the network.
Server public void SendBehaviourDataToClient	int clientId	Synchronizes all data of this behaviour through the network. Used to synchronize the current server state to a new client.
Server public NetworkBehaviourDataPacket GetBehaviourDataPacket		Creates a packet containing all data of this behaviour. Used to synchronize the current server state to a new client.
public void ApplyDirtyValues	byte[] payload	Applies the given payload to the values of this behaviour. used to synchronize the values of this behaviour from the network.
Server public static void ServerBroadcastPacket	IPacket packet bool reliable = false	Broadcasts a packet to all clients. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Server public static void ServerBroadcastPacketExceptFor	IPacket packet int except bool reliable = false	Broadcasts a packet to all clients except for the given client. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Server public static void ServerSendPacket	IPacket packet int clientId bool reliable = false	Sends a packet to the given client. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Client public static void ClientSendPacket	IPacket packet bool reliable = false	Sends a packet to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
public void SendPacket	IPacket packet bool reliable = false	Sends a packet through the network, automatically choosing the correct method. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> Despawn		Despawns the object from the network. Requires authority.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> SetActive	bool active	Changes the active state of the object. Requires authority.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> SetOwner	int clientId	Sets the owner of the object. Requires authority.
Server public void ForceSetOwner	int clientId	Forces the transfer of ownership of the object. Can be called by the server only. Useful for preventing the despawn of object when the owner disconnects.
public static NetworkIdentity GetNetworkObject	NetworkId objectId	Returns the network identity object with the given id.
public static IEnumerable<NetworkIdentity> GetNetworkObjects		Returns all the network identity objects.
public static int GetNetworkObjectCount		Returns the number of network identity objects.
public static IEnumerable<NetworkIdentity> GetNetworkObjectsOwnedBy	int clientId	Returns all the network identity objects owned by the given client. If the client id is -1, it returns all the objects owned by the server.
Client public int GetLocalClientIndex	int clientId	Returns the index of the local client with the given id.
Client public int GetLocalClientCount		Returns the number of local clients.
Client public ReadOnlySpan<int> GetLocalClientIds		returns the client id of all local clients.
public static GameObject GetPrefabById	NetworkId prefab	Returns the prefab object registered with the given id.
public static NetworkId GetIdForPrefab	GameObject prefab	Returns the id of a registered prefab.
public static bool IsPrefabValid	NetworkId prefab	Checks if the prefab is registered.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> MoveToScene	int sceneId	Moves this object to a different scene. Requires authority.
Requires Authority public void MoveToScene	string sceneName	Moves this object to a different scene. Requires authority.
public static IEnumerable<string> GetLoadedScenes		Returns the name of all the scenes loaded on the network.
public static int GetSceneId	string sceneName	Returns the id of the scene with the given name.
public static string GetSceneName	int sceneId	Returns the name of the scene with the given id.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation bool active	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation int owner	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation Vector3 scale bool active int owner = -1 int scene = -1	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded. If the scene id is 0, the object will be spawned in the main scene. If the scene id is -1, the object will be spawned in the last loaded scene. If the owner id is -1, the object will be owned by the server.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	NetworkId prefabId Vector3 position Quaternion rotation Vector3 scale bool active int owner = -1 int scene = -1	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded. If the scene id is 0, the object will be spawned in the main scene. If the scene id is -1, the object will be spawned in the last loaded scene. If the owner id is -1, the object will be owned by the server.

NetworkBehaviourDataPacket

Class NetBuff.Packets.NetworkBehaviourDataPacket

Info

Packet used to synchronize data of a network behaviour.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.
public byte BehaviourId	Get Set	The behaviour id of the network behaviour (index in the network object).
public byte[] Payload	Get Set	The payload of the network behaviour data.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkClientIdPacket

Class NetBuff.Packets.NetworkClientIdPacket

Info

Packet sent from the server to the client to inform the client of its network id.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public int ClientId	Get Set	The client id assigned to the client by the server.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkId

Class NetBuff.Misc.NetworkId

Info

A unique identifier for a network object.
Represented as a 16-character hexadecimal string.
Internally, it is stored as two 32-bit integers.
There are 18,446,744,073,709,551,616 unique network IDs.

Properties

Property	Accessors	Description
public static NetworkId Empty	Get	A network ID with all bits set to 0.
public bool IsEmpty	Get	Checks if the network ID is empty.
public int High	Get	Returns the high 32 bits of the network ID.
public int Low	Get	Returns the low 32 bits of the network ID.

Methods

Method	Parameters	Description
public int CompareTo	object obj	Compares two network IDs. If they are equal, returns 0. If this network ID is less than the other, returns -1. If this network ID is greater than the other, returns 1.
public static NetworkId New		Creates a new random network ID.
public static NetworkId Read	BinaryReader reader	Reads a network ID from a binary reader.
public bool Equals	object obj	Compares two network IDs.
public int GetHashCode		Gets the hash code of the network ID.
public NetworkId Serialize	BinaryWriter writer	Serializes the network ID to a binary writer.
public NetworkId Deserialize	BinaryReader reader	Deserializes the network ID from a binary reader.
public string ToString		Converts the network ID to a 16-character hexadecimal string.
public static bool TryParse	string input object result	Try to parse a network ID from a string.

NetworkIdentity

Class NetBuff.Components.NetworkIdentity

Info

Used to keep the reference of an object throughout the network.
All NetworkIdentity are registered in the NetworkManager.

Properties

Property	Accessors	Description
public NetworkId Id	Get	The network id of this identity.
public int OwnerId	Get	The owner id of this identity. If the owner id is -1, the object is owned by the server.
public NetworkId PrefabId	Get	The id of the prefab used to spawn this identity object. If the prefab id is empty, the object was not spawned from a prefab at runtime.
public bool HasAuthority	Get	Checks if the local environment has authority over this identity.
public bool IsOwnedByClient	Get	Checks if this identity is owned by any client.
public int SceneId	Get	The if of the scene this identity is in.
public static bool IsServer	Get	Checks if the local environment is the server.
public static int LoadedSceneCount	Get	The number of currently loaded scenes on the network.
public static string MainScene	Get	The name of the scene where the NetworkManager is currently in.
public static string LastLoadedScene	Get	The name of the currently last loaded scene.
public NetworkBehaviour[] Behaviours	Get	All the network behaviours attached to this identity.

Methods

Method	Parameters	Description
Server public static void ServerBroadcastPacket	IPacket packet bool reliable = false	Broadcasts a packet to all clients. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Server public static void ServerBroadcastPacketExceptFor	IPacket packet int except bool reliable = false	Broadcasts a packet to all clients except for the given client. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Server public static void ServerSendPacket	IPacket packet int clientId bool reliable = false	Sends a packet to the given client. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Client public static void ClientSendPacket	IPacket packet bool reliable = false	Sends a packet to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
public void SendPacket	IPacket packet bool reliable = false	Sends a packet through the network, automatically choosing the correct method. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> Despawn		Despawns the object from the network. Requires authority.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> SetActive	bool active	Changes the active state of the object. Requires authority.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> SetOwner	int clientId	Sets the owner of the object. Requires authority.
Server public void ForceSetOwner	int clientId	Forces the transfer of ownership of the object. Can be called by the server only. Useful for preventing the despawn of object when the owner disconnects.
public static NetworkIdentity GetNetworkObject	NetworkId objectId	Returns the network identity object with the given id.
public static IEnumerable<NetworkIdentity> GetNetworkObjects		Returns all the network identity objects.
public static int GetNetworkObjectCount		Returns the number of network identity objects.
public static IEnumerable<NetworkIdentity> GetNetworkObjectsOwnedBy	int clientId	Returns all the network identity objects owned by the given client. If the client id is -1, it returns all the objects owned by the server.
Client public int GetLocalClientIndex	int clientId	Returns the index of the local client with the given id.
Client public int GetLocalClientCount		Returns the number of local clients.
Client public ReadOnlySpan<int> GetLocalClientIds		returns the client id of all local clients.
public static GameObject GetPrefabById	NetworkId prefab	Returns the prefab object registered with the given id.
public static NetworkId GetIdForPrefab	GameObject prefab	Returns the id of a registered prefab.
public static bool IsPrefabValid	NetworkId prefab	Checks if the prefab is registered.
Requires Authority public NetworkAction<NetworkId,NetworkIdentity> MoveToScene	int sceneId	Moves this object to a different scene. Requires authority.
Requires Authority public void MoveToScene	string sceneName	Moves this object to a different scene. Requires authority.
public static IEnumerable<string> GetLoadedScenes		Returns the name of all the scenes loaded on the network.
public static int GetSceneId	string sceneName	Returns the id of the scene with the given name.
public static string GetSceneName	int sceneId	Returns the name of the scene with the given id.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation bool active	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation int owner	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	GameObject prefab Vector3 position Quaternion rotation Vector3 scale bool active int owner = -1 int scene = -1	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded. If the scene id is 0, the object will be spawned in the main scene. If the scene id is -1, the object will be spawned in the last loaded scene. If the owner id is -1, the object will be owned by the server.
public static NetworkAction<NetworkId,NetworkIdentity> Spawn	NetworkId prefabId Vector3 position Quaternion rotation Vector3 scale bool active int owner = -1 int scene = -1	Spawns a prefab object on the network. If the object does not have a NetworkIdentity component, the NetworkId will be discarded. If the scene id is 0, the object will be spawned in the main scene. If the scene id is -1, the object will be spawned in the last loaded scene. If the owner id is -1, the object will be owned by the server.

NetworkIdNetworkValue

Class NetBuff.Misc.NetworkIdNetworkValue

Info

Used to store a NetworkId value that is synchronized over the network.
Used to keep reference to other network objets throughout the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

NetworkLoadScenePacket

Class NetBuff.Packets.NetworkLoadScenePacket

Info

Packet sent from the server to the client to inform the client to load a scene.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public string SceneName	Get Set	The name of the scene to load.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkManager

Class NetBuff.NetworkManager

Info

Main NetBuff component that manages the network environment, network objects, network behaviours callbacks, packet
sending and receiving, session data, and scene management.
This component should be placed in the scene that will be used as the main scene for the network environment.
NetworkManager is a singleton class, meaning that only one instance of this component can exist in the scene.

Properties

Property	Accessors	Description
public static NetworkManager Instance	Get Set	Singleton instance of the NetworkManager component.
public string Name	Get Set	Name of the network environment. Used to name the server.
public int VersionMagicNumber	Get Set	Used to check if versions and projects and compatible. When a client connects to a server, the server will check if the client's version magic number matches the server's version magic number.
public int DefaultTickRate	Get Set	Default tick rate of the network environment. Used by components that require a tick rate, such as NetworkTransform.
public bool SpawnsPlayer	Get Set	Determines if the server should spawn a player object for the client when they connect.
public bool SupportsSessionRestoration	Get Set	Determines if the network environment supports session restoration.
public NetworkTransport Transport	Get Set	Determines the network transport used by the network environment.
public NetworkPrefabRegistry PrefabRegistry	Get Set	Determines the network prefab registry used by the network environment.
public GameObject PlayerPrefab	Get Set	Determines the player prefab used by the network environment. The prefab needs to be registered in the network prefab registry.
public bool IsClientRunning	Get Set	Determines if the local client is running.
public bool IsServerRunning	Get Set	Determines if the local server is running.
public IList<NetworkBehaviour> DirtyBehaviours	Get	Returns all network objects that have to be synchronized.
public NetworkTransport.EnvironmentType EnvironmentType	Get	Returns the environment type of the network transport.
Client public IConnectionInfo ClientConnectionInfo	Get	Returns the connection info of the client. Can only be accessed on the client.
Client public ReadOnlySpan<int> LocalClientIds	Get	Returns all the local client ids. Can only be accessed on the client.
public string MainScene	Get	Returns the name of the main scene. The main scene is the scene where the NetworkManager component is placed.
public IEnumerable<string> LoadedScenes	Get	Returns all the loaded scenes.
public int LoadedSceneCount	Get	Returns the number of loaded scenes.
public string LastLoadedScene	Get	Returns the current last loaded scene. If a object is spawned or moved to the -1 scene, it will be placed on the last loaded scene.

Methods

Method	Parameters	Description
public void StartClient		Starts the network environment as client.
public void StartServer		Starts the network environment as server.
public void StartHost		Starts the network environment as host (server and client).
public void Close		Closes the network environment.
public NetworkIdentity GetNetworkObject	NetworkId id	Returns the network identity object with the given id.
public IEnumerable<NetworkIdentity> GetNetworkObjects		Returns all the network identity objects.
public int GetNetworkObjectCount		Returns the number of network identity objects.
public IEnumerable<NetworkIdentity> GetNetworkObjectsOwnedBy	int owner	Returns all the network identity objects owned by the given client. If the client id is -1, it returns all the objects owned by the server.
protected void OnServerError	string error	Called when a error occurs on the server.
protected void OnClientError	string error	Called when a error occurs on the client.
protected void OnServerStart		Called when the server starts.
protected void OnServerStop	NetworkTransport.ConnectionEndMode mode string cause	Called when the server stops.
protected void OnNetworkObjectSpawned	NetworkIdentity identity bool retroactive	Called when a network object is spawned. /// The isRetroactive parameter is true if the client is joining the server after the object is already spawned.
protected void OnNetworkObjectDespawned	NetworkIdentity identity	Called when a network object is despawned.
Server protected void OnClientConnected	int clientId	Called when a client connects to the server. Only called on the server.
Server protected void OnClientDisconnected	int clientId string reason	Called when a client disconnects from the server. Only called on the server.
Server protected void OnSpawnPlayer	int clientId	Called when the server spawns a player object for the client. Only called on the server. Can be used to customize the player object spawn, such as setting the position and rotation.
Client protected void OnConnect		Called when the client connects to the server. Only called on the client.
Client protected void OnDisconnect	NetworkTransport.ConnectionEndMode mode string reason	Called when the client disconnects from the server. Only called on the client.
Server protected void OnServerReceivePacket	int clientId IPacket packet	Called when the server receives a packet from a client. Only called on the server.
protected void OnClientReceivePacket	IPacket packet	Called when the client receives a packet from the server. Only called on the client.
protected void OnClearEnvironment	NetworkTransport.ConnectionEndMode mode string cause	Called when the network environment is cleared. Occurs when the server stops or the client disconnects.
protected GameObject OnSpawnObject	NetworkId id NetworkId prefabId GameObject prefab Vector3 position Quaternion rotation Vector3 scale bool active int owner int sceneId	Called when a network object is spawned. Can be used to customize the object spawn, such as setting the position and rotation. Note: Changes made here are not synchronized through the network automatically and may be overwritten by the object owner.
protected void OnDespawnObject	GameObject o	Called when a network object is despawned.
protected SessionData OnCreateEmptySessionData		Used to create a empty session data object. No data should be initialized here.
Client protected NetworkSessionEstablishRequestPacket OnCreateSessionEstablishRequest		Used to create a session establish request packet. Called when the client connects to the server. Called only on the client.
Client protected void OnLocalSessionDataChanged	SessionData data	Called when the session data of the client changes. Changes only occur when the server updates the session data via ApplyChanges Called only on the client.
Server protected SessionData OnRestoreSessionData	int clientId NetworkSessionEstablishRequestPacket requestPacket	Used to restore the session data of the client. If the client has disconnected and the server supports session restoration, this method is called to restore the session data. If no session data is found, the client will be treated as a new client. Note that the client id is not kept between sessions, only the session custom data. Called only on the server.
Server protected SessionData OnCreateNewSessionData	int clientId NetworkSessionEstablishRequestPacket requestPacket	Called when no restored session data is found. Called only on the server.
Server protected SessionEstablishingResponse OnSessionEstablishingRequest	NetworkSessionEstablishRequestPacket requestPacket	Called when the server receives a session establish request packet. Here the server can accept or reject the client connection. If the server rejects the connection, the client will be disconnected. Called only on the server.
Server protected void SpawnNetworkObjectForClients	NetworkId prefabId Vector3 position Quaternion rotation Vector3 scale int owner = -1 int scene = -1	Spawns a network object for all clients. Shall only be used internally. Called only on the server.
Server protected void SetNetworkObjectOwnerForClients	NetworkId id int owner	Sets the owner of the network object for all clients. Shall only be used internally. Called only on the server.
Server protected void SetNetworkObjectActiveForClients	NetworkId id bool active	Sets the active state of the network object for all clients. Shall only be used internally. Called only on the server.
Server protected void DespawnNetworkObjectForClients	NetworkId id	Despawns the network object for all clients. Shall only be used internally. Called only on the server.
Server protected void MoveObjectToScene	NetworkId id int sceneId	Used to move a network object to another scene. Shall only be used internally. Called only on the server.
Client public void ClientSendPacket	IPacket packet bool reliable = false	Sends a packet to the server. Called only on the client.
Server public void ServerSendPacket	IPacket packet int target = -1 bool reliable = false	Sends a packet to a client. If the target is -1, the packet is sent to all clients. Called only on the server.
Server public void BroadcastServerPacket	IPacket packet bool reliable = false	Broadcasts a packet to all clients. Called only on the server.
Server public void BroadcastServerPacketExceptFor	IPacket packet int except bool reliable = false	Broadcasts a packet to all clients except for the given client. Called only on the server.
public int GetSceneId	string sceneName	Returns the scene id of the given scene name. If the scene name is not found, returns -1.
public string GetSceneName	int sceneId	Returns the scene name of the given scene id. If the scene id is -1, returns the last loaded scene. If the scene id is 0, returns the main scene.
Server public NetworkAction<string,int> LoadScene	string sceneName	Loads a scene through the network. Called only on the server.
Server public NetworkAction<string,int> UnloadScene	string sceneName	Unloads a scene through the network. Called only on the server.
public bool IsSceneLoaded	string sceneName	Checks if the scene is loaded.
Server public IEnumerable<int> GetConnectedClients		Returns the id of all connected clients. Called only on the server.
Server public int GetConnectedClientCount		Returns the count of all connected clients. Called only on the server.
Server public bool TryGetSessionData	int clientId T data	Try to get the session data of the client. Called only on the server.
Server public IEnumerable GetAllSessionData		Returns the session data of all connected clients. Called only on the server.
Server public IEnumerable GetAllDisconnectedSessionData		Returns the session data of all disconnected clients. Called only on the server.
Server public void ClearAllDisconnectedSessionData		Clears all disconnected session data. Called only on the server.
Server public void SendSessionDataToClient	int clientId	Re-syncs the session data of the client. Called only on the server.
Server public void SendSessionDataToClient	SessionData data	Re-syncs the session data of the client. Called only on the server.
Client public T GetLocalSessionData	int clientId = -1	Returns the session data of the local client. Called only on the client.

NetworkManagerGUI

Class NetBuff.NetworkManagerGUI

Info

NetworkManagerGUI is a simple GUI for NetworkManager.
Provides a simple way to start a server, client, or host.
Also provides a way to see the server list and connect to them.
Can plot graphs for FPS, Latency, Packet Sent, Packet Received, and Packet Loss.
Displays the current status of the server and client.

Properties

Property	Accessors	Description
public bool PlotFPS	Get Set	Determines whether the FPS graph is plotted.
public bool PlotLatency	Get Set	Determines whether the Latency graph is plotted.
public bool PlotPacketRate	Get Set	Determines whether the Packet Rate graph is plotted.
public CurrentGraph CurrentGraphType	Get Set	Determines the current rendered graph type.

NetworkObjectActivePacket

Class NetBuff.Packets.NetworkObjectActivePacket

Info

Packet used to change the active state of a network object.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.
public bool IsActive	Get Set	The active state of the network object.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkObjectDespawnPacket

Class NetBuff.Packets.NetworkObjectDespawnPacket

Info

Packet used to despawn a network object.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkObjectMoveScenePacket

Class NetBuff.Packets.NetworkObjectMoveScenePacket

Info

Packet used to move a network object to a new scene.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.
public int SceneId	Get Set	The scene id to move the network object to.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkObjectOwnerPacket

Class NetBuff.Packets.NetworkObjectOwnerPacket

Info

Packet used to change the owner of a network object.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.
public int OwnerId	Get Set	The owner id of the network object.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkObjectSpawnPacket

Class NetBuff.Packets.NetworkObjectSpawnPacket

Info

Packet used to spawn a network object.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The network id of the network object.
public NetworkId PrefabId	Get Set	The network id of the prefab.
public int OwnerId	Get Set	The owner id of the network object. If the owner id is -1, the object will be owned by the server.
public Vector3 Position	Get Set	The position of the network object.
public Quaternion Rotation	Get Set	The rotation of the network object.
public Vector3 Scale	Get Set	The scale of the network object.
public bool IsActive	Get Set	The active state of the network object.
public int SceneId	Get Set	The scene id of the network object. If the scene id is 0, the object will be spawned in the main scene. If the scene id is -1, the object will be spawned in the last loaded scene.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkPreExistingInfoPacket

Class NetBuff.Packets.NetworkPreExistingInfoPacket

Info

Packet used to send information about pre-existing objects in the network.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public PreExistingState[] PreExistingObjects	Get Set	The pre-existing objects in the network.
public NetworkId[] RemovedObjects	Get Set	The id of the pre-existing objects that were removed from the network.
public string[] SceneNames	Get Set	The names of the scenes that are loaded in the network.
public NetworkObjectSpawnPacket[] SpawnedObjects	Get Set	The spawned objects in the network.
public NetworkBehaviourDataPacket[] NetworkValues	Get Set	The data of the network behaviours in the network.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkPreExistingResponsePacket

Class NetBuff.Packets.NetworkPreExistingResponsePacket

Info

Packet used to confirm that the client has synchronized the server state.
This allows the server to confirm the client connection.

Implements

NetBuff.Interface.IPacket

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkPrefabRegistry

Class NetBuff.NetworkPrefabRegistry

Info

Registry of prefabs that can be spawned by the network.
All the objects that are spawned at runtime by the network must be registered here.

Properties

Property	Accessors	Description
public SerializedDictionary<NetworkId,GameObject> Prefabs	Get	Registry of prefabs that can be spawned by the network.

Methods

Method	Parameters	Description
public bool IsPrefabValid	NetworkId id	Check if a prefab id is valid.
public bool IsPrefabValid	GameObject prefab	Check if a prefab is valid.
public NetworkId GetPrefabId	GameObject prefab	Returns the prefab id of a prefab.
public GameObject GetPrefab	NetworkId id	Returns the prefab of a prefab id.
public IEnumerable GetAllPrefabs		Returns all the prefabs.

NetworkRigidbodyTransform

Class NetBuff.Components.NetworkRigidbodyTransform

Info

Syncs the components of a transform over the network, along with the velocity and angular velocity of a Rigidbody.

Implements

NetBuff.Components.NetworkTransform

Properties

Property	Accessors	Description
public Rigidbody Rigidbody	Get	The Rigidbody component to sync.
public bool SyncVelocity	Get Set	Defines whether the velocity should be synced.
public float VelocityThreshold	Get Set	Defines the threshold for the velocity to be considered changed.
public bool SyncAngularVelocity	Get Set	Defines whether the angular velocity should be synced.
public float AngularVelocityThreshold	Get Set	Defines the threshold for the angular velocity to be considered changed.
public bool SyncIsKinematic	Get Set	Defines whether the isKinematic property should be synced.

Methods

Method	Parameters	Description
protected bool ShouldResend Overrides	TransformPacket packet	Determines if the transform should be resent to the server.
protected void ApplyTransformPacket Overrides	TransformPacket packet	Applies the transform components to the transform.

NetworkSessionDataPacket

Class NetBuff.Packets.NetworkSessionDataPacket

Info

Packet used to synchronize the session data of a client.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public int ClientId	Get Set	The id of the client.
public ArraySegment<byte> Data	Get Set	The data of the session.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkSessionEstablishRequestPacket

Class NetBuff.Packets.NetworkSessionEstablishRequestPacket

Info

Base packet for all session establish request packets.

Implements

NetBuff.Interface.IPacket

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkTransform

Class NetBuff.Components.NetworkTransform

Info

Syncs the components of a transform over the network.

Implements

NetBuff.Components.NetworkBehaviour

Properties

Property	Accessors	Description
public int TickRate	Get Set	Determines the tick rate of the NetworkAnimator. When set to -1, the default tick rate of the NetworkManager will be used.
public float PositionThreshold	Get Set	Defines the threshold for the position to be considered changed.
public float RotationThreshold	Get Set	Defines the threshold for the rotation to be considered changed.
public float ScaleThreshold	Get Set	Defines the threshold for the scale to be considered changed.
public SyncMode SyncModeMask	Get	Defines which components of the transform should be synced.

Methods

Method	Parameters	Description
public void OnOwnershipChanged Overrides	int oldOwner int newOwner	Called when the owner of this object changes.
public void OnSpawned Overrides	bool isRetroactive	Called when this object is spawned on the network. Called when the network environment initializes if the object already exists. The isRetroactive parameter is true if the client is joining the server after the object is already spawned.
public void OnServerReceivePacket Overrides	IOwnedPacket packet int clientId	Called when the server receives a packet owned by this object from a client
public void OnClientReceivePacket Overrides	IOwnedPacket packet	Called when the clients receive a packet owned by this object from the server.
protected bool ShouldResend	TransformPacket packet	Determines if the transform should be resent to the server.
protected void ApplyTransformPacket	TransformPacket packet	Applies the transform components to the transform.

NetworkTransport

Class NetBuff.NetworkTransport

Info

Base class for network transport.
Responsible for internally managing the connection between the server and clients.
Holds the connection information of clients and provides methods for sending and receiving packets.

Properties

Property	Accessors	Description
public EnvironmentType Type	Get Set	The current type of the network environment.
Client public IConnectionInfo ClientConnectionInfo	Get Set	The local client connection to the server information.
public Action<int,IPacket> OnServerPacketReceived	Get Set	The callback that will be called when a packet is received by the server.
public Action<IPacket> OnClientPacketReceived	Get Set	The callback that will be called when a packet is received by the client.
public Action<int> OnClientConnected	Get Set	The callback that will be called when a client is connected to the server.
public Action<int,string> OnClientDisconnected	Get Set	The callback that will be called when a client is disconnected from the server.
public Action OnConnect	Get Set	The callback that will be called when the client connects to the server.
public Action<ConnectionEndMode,string> OnDisconnect	Get Set	The callback that will be called when the client disconnects from the server.
public Action OnServerStart	Get Set	The callback that will be called when the server starts.
public Action<ConnectionEndMode,string> OnServerStop	Get Set	The callback that will be called when the server stops.

Methods

Method	Parameters	Description
public ServerDiscoverer GetServerDiscoverer		Returns a new discoverer that will be used to find available servers.
public void StartHost	int magicNumber	Starts the network transport as a host (server and client).
public void StartServer		Starts the network transport as a server.
public void StartClient	int magicNumber	Starts the network transport as a client.
public void Close		Closes the network transport.
Server public IClientConnectionInfo GetClientInfo	int id	Returns the connection information of the client with the given id.
Server public int GetClientCount		Returns the number of clients connected to the server.
Server public IEnumerable<IClientConnectionInfo> GetClients		Returns all the clients connected to the server.
Client public void ClientDisconnect	string reason	Disconnects the client from the server.
Server public void ServerDisconnect	int id string reason	Disconnects the client with the given id from the server.
Client public void ClientSendPacket	IPacket packet bool reliable = false	Sends a packet to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
Server public void ServerSendPacket	IPacket packet int target = -1 bool reliable = false	Sends a packet to the client with the given id. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered. If the target is -1, the packet will be sent to all clients connected to the server.
Server public void BroadcastServerPacket	IPacket packet bool reliable = false	Broadcasts a packet to all clients connected to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.

NetworkUnloadScenePacket

Class NetBuff.Packets.NetworkUnloadScenePacket

Info

Packet sent from the server to the client to inform the client to unload a scene.

Implements

NetBuff.Interface.IPacket

Properties

Property	Accessors	Description
public string SceneName	Get Set	The name of the scene to unload.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

NetworkValue

Class NetBuff.Misc.NetworkValue

Info

Base class for all network values.
Used to store values that are synchronized over the network.

Properties

Property	Accessors	Description
public NetworkBehaviour AttachedTo	Get Set	The behaviour that this value is attached to.

Methods

Method	Parameters	Description
public void Serialize	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize	BinaryReader reader	Deserializes the value from a binary reader.

NetworkValue<T>

Class NetBuff.Misc.NetworkValue<T>

Info

Base class for all network values.
Used to store values that are synchronized over the network.

Implements

NetBuff.Misc.NetworkValue

Properties

Property	Accessors	Description
public T Value	Get Set	The value of this network value. Can only be set if the local environment has permission. Use the CheckPermission method to check if the environment has permission.

Methods

Method	Parameters	Description
public bool CheckPermission		Checks if the environment has permission to modify this value.
protected void SetValueCalling	T newValue	Used to set the value of this network value. Shall only be used internally.
public string ToString		Returns a string representation of this network value.

PacketListener

Class NetBuff.Misc.PacketListener

Info

Base class for packet listeners
Used to listen for packets and call events when a packet is received

Methods

Method	Parameters	Description
public static PacketListener GetPacketListener		Returns the packet listener for the given packet type.
public static PacketListener GetPacketListener	Type type	Returns the packet listener for the given packet type.
public bool CallOnServerReceive	IPacket packet int client	Call the OnServerReceive event. Can be used to simulate a server receiving a packet.
public bool CallOnClientReceive	IPacket packet	Call the OnClientReceive event. Can be used to simulate a client receiving a packet.

PacketListener<T>

Class NetBuff.Misc.PacketListener<T>

Info

Generic packet listener. Used to listen for packets of a specific type.

Implements

NetBuff.Misc.PacketListener

Methods

Method	Parameters	Description
public void AddServerListener	Funcint\,\bool\> callback
public void AddClientListener	Funcbool\> callback
public void RemoveServerListener	Funcint\,\bool\> callback
public void RemoveClientListener	Funcbool\> callback
public bool CallOnServerReceive Overrides	IPacket packet int client	Call the OnServerReceive event. Can be used to simulate a server receiving a packet.
public bool CallOnClientReceive Overrides	IPacket packet	Call the OnClientReceive event. Can be used to simulate a client receiving a packet.

PacketRegistry

Class NetBuff.PacketRegistry

Info

A registry for packet types.
Allows for easy creation of packets by ID.

Methods

Method	Parameters	Description
public static void RegisterPacket		Registers a packet type.
public static void RegisterPacket	Type type	Registers a packet type.
public static void Clear		Clears the registry.
public static int GetId		Returns the id of a packet type.
public static int GetId	IPacket packet	Returns the id of a packet.
public static IPacket CreatePacket	int id	Creates a packet by its id.

Platform

Enum NetBuff.Misc.Platform

Info

Represents the platform the application is running on.

Enum Values

Value	Description
Desktop	A generic desktop platform.
Windows	The Windows platform (editor or player).
Linux	The Linux platform.
MacOS	The MacOS platform (editor or player).
Mobile	A generic mobile platform.
Android	Android platform.
IOS	iOS platform.
Unknown	Unknown platform.

PlatformExtensions

Class NetBuff.Misc.PlatformExtensions

Info

Utility class for platform related operations.

Methods

Method	Parameters	Description
public static Platform GetPlatform		Returns the platform the application is running on.

PreExistingState

Class NetBuff.Packets.NetworkPreExistingInfoPacket.PreExistingState

Info

Represents the state of a pre-existing object in the network.

Properties

Property	Accessors	Description
public NetworkId Id	Get Set	The id of the object.
public NetworkId PrefabId	Get Set	The id of the prefab.
public int OwnerId	Get Set	The id of the owner of the object.
public Vector3 Position	Get Set	The position of the object.
public Quaternion Rotation	Get Set	The rotation of the object.
public Vector3 Scale	Get Set	The scale of the object.
public bool IsActive	Get Set	The state of the object.
public int SceneId	Get Set	The id of the scene where the object is.

QuaternionNetworkValue

Class NetBuff.Misc.QuaternionNetworkValue

Info

Used to store a Quaternion value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

RequiresAuthorityAttribute

Class NetBuff.Misc.RequiresAuthorityAttribute

Info

Used to mark a method, field or property as requiring authority.
If a method, field or property is marked with this attribute, it will only be used if the local environment has
authority over the object.

ServerDiscoverer

Class NetBuff.Discover.ServerDiscoverer

Info

Base class for server discovery. Used to find servers and retrieve their information.

Methods

Method	Parameters	Description
public void Search	Action<ServerInfo> onFindServer Action onFinish	Start searching for servers. For each server found, the onFindServer callback will be called. After the search is finished, the onFinish callback will be called.
public void Cancel		Cancel the search. When this method is called, the onFinish callback will not be called.

ServerDiscoverer<T>

Class NetBuff.Discover.ServerDiscoverer<T>

Info

Base class for server discovery. Used to find servers and retrieve their information.

Implements

NetBuff.Discover.ServerDiscoverer

Methods

Method	Parameters	Description
public void Search Overrides	Action onFindServer Action onFinish	Start searching for servers. For each server found, the onFindServer callback will be called. After the search is finished, the onFinish callback will be called.
public void Search	Action<ServerInfo> onFindServer Action onFinish	Start searching for servers. For each server found, the onFindServer callback will be called. After the search is finished, the onFinish callback will be called.

ServerInfo

Class NetBuff.Discover.ServerDiscoverer.ServerInfo

Info

Holds the information about a server.

Properties

Property	Accessors	Description
public string Name	Get Set	The server's name. Normally the host's name.
public int Players	Get Set	The number of players currently in the server.
public int MaxPlayers	Get Set	The maximum number of players that can join the server at the same time.
public Platform Platform	Get Set	The platform the server is running on.
public bool HasPassword	Get Set	Returns true if the server is password protected.
public string Method	Get Set	Returns the method used to connect to the server (UDP, Bluetooth, etc).

Methods

Method	Parameters	Description
public string ToString		Format the server information to a string.
public bool Join		Join the server.

ServerOnlyAttribute

Class NetBuff.Misc.ServerOnlyAttribute

Info

Used to mark a method, field or property as server only.
This means that the method, field or property will only be used on the server side.

SessionData

Class NetBuff.Session.SessionData

Info

Base class for session data. Used to store data such as client score, team, etc.
Persistent in case of reconnection. Check Managing Sessions section in the documentation for more info.

Properties

Property	Accessors	Description
public int ClientId	Get	Holds the client id that owns this session data.

Methods

Method	Parameters	Description
public void Serialize	BinaryWriter writer bool shouldSerializeEverything	Serializes data to byte array. The parameter shouldSerializeEverything will only be true when the server is hot-reloading.
public void Deserialize	BinaryReader reader bool shouldDeserializeEverything	Deserializes data from byte array. The parameter shouldDeserializeEverything will only be true when the server is hot-reloading.
Server public void ApplyChanges		Used to re-sync data to the client.

SessionEstablishingResponse

Struct NetBuff.Session.SessionEstablishingResponse

Info

Response to a session establishing request.
If the response is accept, the session will be established.
If the response is reject, the session will not be established, and the client will be disconnected.

Properties

Property	Accessors	Description
public SessionEstablishingResponseType Type	Get Set	The type of response.
public string Reason	Get Set	The reason for rejecting the session establishing request.

SessionEstablishingResponseType

Enum NetBuff.Session.SessionEstablishingResponseType

Enum Values

Value	Description
Accept	Accept the session establishing request.
Reject	Reject the session establishing request.

ShortNetworkValue

Class NetBuff.Misc.ShortNetworkValue

Info

Used to store a short value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

StringNetworkValue

Class NetBuff.Misc.StringNetworkValue

Info

Used to store a string value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

SyncMode

Enum NetBuff.Components.NetworkTransform.SyncMode

Enum Values

Value	Description
None	No components are synced.
PositionX	The x position of the transform is synced.
PositionY	The y position of the transform is synced.
PositionZ	The z position of the transform is synced.
RotationX	The x rotation of the transform is synced.
RotationY	The y rotation of the transform is synced.
RotationZ	The z rotation of the transform is synced.
ScaleX	The x scale of the transform is synced.
ScaleY	The y scale of the transform is synced.
ScaleZ	The z scale of the transform is synced.

TransformPacket

Class NetBuff.Components.TransformPacket

Info

Packet used to sync the transform components.

Implements

NetBuff.Interface.IOwnedPacket

Properties

Property	Accessors	Description
public float[] Components	Get Set	The components of the transform.
public short Flag	Get Set	Determines which components have been changed.
public NetworkId Id Overrides	Get Set	The id of the owner of the packet.

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the packet to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the packet from a binary reader.

UDPNetworkTransport

Class NetBuff.UDP.UDPNetworkTransport

Info

Uses the UDP (User Datagram Protocol) protocol to manage the connection between the server and clients.
Responsible for internally managing the connection between the server and clients.
Holds the connection information of clients and provides methods for sending and receiving packets.

Implements

NetBuff.NetworkTransport

Properties

Property	Accessors	Description
public string Address	Get Set	The address of the server.
public int Port	Get Set	The port of the server / client connection.
public string Password	Get Set	The password of the server. The password that the client is using to connect to the server.
public int MaxClients	Get Set	The maximum number of clients that can connect to the server at the same time.

Methods

Method	Parameters	Description
public ServerDiscoverer GetServerDiscoverer Overrides		Returns a new discoverer that will be used to find available servers.
public void StartHost Overrides	int magicNumber	Starts the network transport as a host (server and client).
public void StartServer Overrides		Starts the network transport as a server.
public void StartClient Overrides	int magicNumber	Starts the network transport as a client.
public void Close Overrides		Closes the network transport.
public IClientConnectionInfo GetClientInfo Overrides	int id	Returns the connection information of the client with the given id.
public int GetClientCount Overrides		Returns the number of clients connected to the server.
public IEnumerable<IClientConnectionInfo> GetClients Overrides		Returns all the clients connected to the server.
public void ClientDisconnect Overrides	string reason	Disconnects the client from the server.
public void ServerDisconnect Overrides	int id string reason	Disconnects the client with the given id from the server.
public void ClientSendPacket Overrides	IPacket packet bool reliable = false	Sends a packet to the server. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered.
public void ServerSendPacket Overrides	IPacket packet int target = -1 bool reliable = false	Sends a packet to the client with the given id. You can choose if the packet should be reliable or not. Reliable packets are guaranteed to be delivered, but they are a little slower. Non-reliable packets are faster, but they are not guaranteed to be delivered. If the target is -1, the packet will be sent to all clients connected to the server.

UDPServerDiscoverer

Class NetBuff.UDP.UDPServerDiscoverer

Info

Used to find all available servers using UDP.
Searches through all available network interfaces and sends a broadcast message to find servers.

Implements

NetBuff.Discover.ServerDiscoverer<T>

Methods

Method	Parameters	Description
public void Search Overrides	Action<UDPServerInfo> onFindServer Action onFinish	Start searching for servers. For each server found, the onFindServer callback will be called. After the search is finished, the onFinish callback will be called.
public void Cancel Overrides		Cancel the search. When this method is called, the onFinish callback will not be called.

UDPServerInfo

Class NetBuff.UDP.UDPServerDiscoverer.UDPServerInfo

Info

Holds the information about a UDP server.

Implements

NetBuff.Discover.ServerDiscoverer.ServerInfo

Properties

Property	Accessors	Description
public IPAddress Address	Get Set	The server's IP address.

Methods

Method	Parameters	Description
public string ToString Overrides		Format the server information to a string.
public bool Join Overrides		Join the server.

Vector2NetworkValue

Class NetBuff.Misc.Vector2NetworkValue

Info

Used to store a Vector2 value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

Vector3NetworkValue

Class NetBuff.Misc.Vector3NetworkValue

Info

Used to store a Vector3 value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.

Vector4NetworkValue

Class NetBuff.Misc.Vector4NetworkValue

Info

Used to store a Vector4 value that is synchronized over the network.

Implements

NetBuff.Misc.NetworkValue<T>

Methods

Method	Parameters	Description
public void Serialize Overrides	BinaryWriter writer	Serializes the value to a binary writer.
public void Deserialize Overrides	BinaryReader reader	Deserializes the value from a binary reader.