docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class UNetTransport

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    NetworkTransport
    UNetTransport
    Inherited Members
    NetworkTransport.IsSupported
    NetworkTransport.OnTransportEvent
    NetworkTransport.InvokeOnTransportEvent(NetworkEvent, ulong, ArraySegment<byte>, float)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Netcode.Transports.UNET
    Assembly: Unity.Netcode.Runtime.dll
    Syntax
    [AddComponentMenu("Netcode/UNet Transport")]
    public class UNetTransport : NetworkTransport

    Fields

    ConnectAddress

    Declaration
    public string ConnectAddress
    Field Value
    Type Description
    string

    ConnectPort

    Declaration
    public int ConnectPort
    Field Value
    Type Description
    int

    MaxConnections

    Declaration
    public int MaxConnections
    Field Value
    Type Description
    int

    MaxSentMessageQueueSize

    Declaration
    public int MaxSentMessageQueueSize
    Field Value
    Type Description
    int

    MessageBufferSize

    Declaration
    public int MessageBufferSize
    Field Value
    Type Description
    int

    MessageSendMode

    Declaration
    public UNetTransport.SendMode MessageSendMode
    Field Value
    Type Description
    UNetTransport.SendMode

    ServerListenPort

    Declaration
    public int ServerListenPort
    Field Value
    Type Description
    int

    Properties

    ServerClientId

    A constant clientId that represents the server When this value is found in methods such as Send, it should be treated as a placeholder that means "the server"

    Declaration
    public override ulong ServerClientId { get; }
    Property Value
    Type Description
    ulong
    Overrides
    NetworkTransport.ServerClientId

    Methods

    DisconnectLocalClient()

    Disconnects the local client from the server

    Declaration
    public override void DisconnectLocalClient()
    Overrides
    NetworkTransport.DisconnectLocalClient()

    DisconnectRemoteClient(ulong)

    Disconnects a client from the server

    Declaration
    public override void DisconnectRemoteClient(ulong clientId)
    Parameters
    Type Name Description
    ulong clientId

    The clientId to disconnect

    Overrides
    NetworkTransport.DisconnectRemoteClient(ulong)

    GetCurrentRtt(ulong)

    Gets the round trip time for a specific client. This method is optional

    Declaration
    public override ulong GetCurrentRtt(ulong clientId)
    Parameters
    Type Name Description
    ulong clientId

    The clientId to get the RTT from

    Returns
    Type Description
    ulong

    Returns the round trip time in milliseconds

    Overrides
    NetworkTransport.GetCurrentRtt(ulong)

    Initialize(NetworkManager)

    Initializes the transport

    Declaration
    public override void Initialize(NetworkManager networkManager = null)
    Parameters
    Type Name Description
    NetworkManager networkManager

    optionally pass in NetworkManager

    Overrides
    NetworkTransport.Initialize(NetworkManager)

    LateUpdate()

    Declaration
    protected void LateUpdate()

    PollEvent(out ulong, out ArraySegment<byte>, out float)

    Polls for incoming events, with an extra output parameter to report the precise time the event was received.

    Declaration
    public override NetworkEvent PollEvent(out ulong clientId, out ArraySegment<byte> payload, out float receiveTime)
    Parameters
    Type Name Description
    ulong clientId

    The clientId this event is for

    ArraySegment<byte> payload

    The incoming data payload

    float receiveTime

    The time the event was received, as reported by Time.realtimeSinceStartup.

    Returns
    Type Description
    NetworkEvent

    Returns the event type

    Overrides
    NetworkTransport.PollEvent(out ulong, out ArraySegment<byte>, out float)

    Send(ulong, ArraySegment<byte>, NetworkDelivery)

    Send a payload to the specified clientId, data and networkDelivery.

    Declaration
    public override void Send(ulong clientId, ArraySegment<byte> payload, NetworkDelivery networkDelivery)
    Parameters
    Type Name Description
    ulong clientId

    The clientId to send to

    ArraySegment<byte> payload

    The data to send

    NetworkDelivery networkDelivery

    The delivery type (QoS) to send data with

    Overrides
    NetworkTransport.Send(ulong, ArraySegment<byte>, NetworkDelivery)

    Shutdown()

    Shuts down the transport

    Declaration
    public override void Shutdown()
    Overrides
    NetworkTransport.Shutdown()

    StartClient()

    Connects client to the server

    Declaration
    public override bool StartClient()
    Returns
    Type Description
    bool

    Returns success or failure

    Overrides
    NetworkTransport.StartClient()

    StartServer()

    Starts to listening for incoming clients

    Declaration
    public override bool StartServer()
    Returns
    Type Description
    bool

    Returns success or failure

    Overrides
    NetworkTransport.StartServer()
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)