Class ClientManager

A container for local client data and actions.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

ClientManager

Inherited Members

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindFirstObjectByType<T>()

UnityEngine.Object.FindAnyObjectByType<T>()

UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindFirstObjectByType(System.Type)

UnityEngine.Object.FindAnyObjectByType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FishNet.Managing.Client

Assembly: FishNet.Runtime.dll

Syntax

[DisallowMultipleComponent]
[AddComponentMenu("FishNet/Manager/ClientManager")]
public sealed class ClientManager : MonoBehaviour

Fields

Clients

All currently connected clients. This field only contains data while ServerManager.ShareIds is enabled.

Declaration

public Dictionary<int, NetworkConnection> Clients

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.Int32, NetworkConnection>

Connection

NetworkConnection the local client is using to send data to the server.

Declaration

public NetworkConnection Connection

Field Value

Type	Description
NetworkConnection

Properties

IsServerDevelopment

This is set true if the server has notified the client it is using a development build. Value is set before authentication.

Declaration

public bool IsServerDevelopment { get; }

Property Value

Type	Description
System.Boolean

NetworkManager

NetworkManager for client.

Declaration

[HideInInspector]
public NetworkManager NetworkManager { get; }

Property Value

Type	Description
NetworkManager

Objects

Handling and information for objects known to the local client.

Declaration

public ClientObjects Objects { get; }

Property Value

Type	Description
ClientObjects

Started

True if the client connection is connected to the server.

Declaration

public bool Started { get; }

Property Value

Type	Description
System.Boolean

Methods

Broadcast<T>(T, Channel)

Sends a Broadcast to the server.

Declaration

public void Broadcast<T>(T message, Channel channel = Channel.Reliable)
    where T : struct, IBroadcast

Parameters

Type	Name	Description
T	message	Broadcast data being sent; for example: an instance of your broadcast type.
Channel	channel	Channel to send on.

Type Parameters

Name	Description
T	Type of broadcast to send.

GetTransportIndex()

Gets the transport index being used for the local client. If only one transport is used this will return 0. If Multipass is being used this will return the client's transport in multipass.

Declaration

public int GetTransportIndex()

Returns

Type	Description
System.Int32

RegisterBroadcast<T>(Action<T, Channel>)

Registers a method to call when a Broadcast arrives.

Declaration

public void RegisterBroadcast<T>(Action<T, Channel> handler)
    where T : struct, IBroadcast

Parameters

Type	Name	Description
System.Action<T, Channel>	handler	Method to call.

Type Parameters

Name	Description
T	Type of broadcast being registered.

SetFrameRate(UInt16)

Declaration

public void SetFrameRate(ushort value)

Parameters

Type	Name	Description
System.UInt16	value

SetRemoteServerTimeout(RemoteTimeoutType, UInt16)

Sets timeout settings. Can be used at runtime.

Declaration

public void SetRemoteServerTimeout(RemoteTimeoutType timeoutType, ushort duration)

Parameters

Type	Name	Description
RemoteTimeoutType	timeoutType
System.UInt16	duration

StartConnection()

Starts the local client connection.

Declaration

public bool StartConnection()

Returns

Type	Description
System.Boolean

StartConnection(String)

Sets the transport address and starts the local client connection.

Declaration

public bool StartConnection(string address)

Parameters

Type	Name	Description
System.String	address

Returns

Type	Description
System.Boolean

StartConnection(String, UInt16)

Sets the transport address and port, and starts the local client connection.

Declaration

public bool StartConnection(string address, ushort port)

Parameters

Type	Name	Description
System.String	address
System.UInt16	port

Returns

Type	Description
System.Boolean

StopConnection()

Stops the local client connection.

Declaration

public bool StopConnection()

Returns

Type	Description
System.Boolean

UnregisterBroadcast<T>(Action<T, Channel>)

Unregisters a method call from a Broadcast type.

Declaration

public void UnregisterBroadcast<T>(Action<T, Channel> handler)
    where T : struct, IBroadcast

Parameters

Type	Name	Description
System.Action<T, Channel>	handler	Method to unregister.

Type Parameters

Name	Description
T	Type of broadcast being unregistered.

Events

OnAuthenticated

Called after local client has authenticated.

Declaration

public event Action OnAuthenticated

Event Type

Type	Description
System.Action

OnClientConnectionState

Called after the local client connection state changes.

Declaration

public event Action<ClientConnectionStateArgs> OnClientConnectionState

Event Type

Type	Description
System.Action<ClientConnectionStateArgs>

OnClientTimeOut

Called when the local client connection to the server has timed out. This is called immediately before disconnecting.

Declaration

public event Action OnClientTimeOut

Event Type

Type	Description
System.Action

OnConnectedClients

Called when the server sends all currently connected clients. This is only available when using ServerManager.ShareIds.

Declaration

public event Action<ConnectedClientsArgs> OnConnectedClients

Event Type

Type	Description
System.Action<ConnectedClientsArgs>

OnRemoteConnectionState

Called when a client other than self connects. This is only available when using ServerManager.ShareIds.

Declaration

public event Action<RemoteConnectionStateArgs> OnRemoteConnectionState

Event Type

Type	Description
System.Action<RemoteConnectionStateArgs>