docs.unity3d.com
    Show / Hide Table of Contents

    Class NetworkUpdateLoop

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

    Inheritance
    Object
    NetworkUpdateLoop
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Netcode
    Syntax
    public static class NetworkUpdateLoop

    Fields

    UpdateStage

    The current network update stage being executed.

    Declaration
    public static NetworkUpdateStage UpdateStage
    Field Value
    Type Description
    NetworkUpdateStage

    Methods

    RegisterAllNetworkUpdates(INetworkUpdateSystem)

    Registers a network update system to be executed in all network update stages.

    Declaration
    public static void RegisterAllNetworkUpdates(this INetworkUpdateSystem updateSystem)
    Parameters
    Type Name Description
    INetworkUpdateSystem updateSystem

    The INetworkUpdateSystem implementation to register for all network updates

    RegisterNetworkUpdate(INetworkUpdateSystem, NetworkUpdateStage)

    Registers a network update system to be executed in a specific network update stage.

    Declaration
    public static void RegisterNetworkUpdate(this INetworkUpdateSystem updateSystem, NetworkUpdateStage updateStage = NetworkUpdateStage.Update)
    Parameters
    Type Name Description
    INetworkUpdateSystem updateSystem

    The INetworkUpdateSystem implementation to register for all network updates

    NetworkUpdateStage updateStage

    The NetworkUpdateStage being registered for the INetworkUpdateSystem implementation

    UnregisterAllNetworkUpdates(INetworkUpdateSystem)

    Unregisters a network update system from all network update stages.

    Declaration
    public static void UnregisterAllNetworkUpdates(this INetworkUpdateSystem updateSystem)
    Parameters
    Type Name Description
    INetworkUpdateSystem updateSystem

    The INetworkUpdateSystem implementation to deregister from all network updates

    UnregisterNetworkUpdate(INetworkUpdateSystem, NetworkUpdateStage)

    Unregisters a network update system from a specific network update stage.

    Declaration
    public static void UnregisterNetworkUpdate(this INetworkUpdateSystem updateSystem, NetworkUpdateStage updateStage = NetworkUpdateStage.Update)
    Parameters
    Type Name Description
    INetworkUpdateSystem updateSystem

    The INetworkUpdateSystem implementation to deregister from all network updates

    NetworkUpdateStage updateStage

    The NetworkUpdateStage to be deregistered from the INetworkUpdateSystem implementation

    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023