docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SceneSwitchProgress

    Class for tracking scene switching progress by server and clients.

    Inheritance
    object
    SceneSwitchProgress
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: MLAPI.SceneManagement
    Assembly: Unity.Multiplayer.MLAPI.Runtime.dll
    Syntax
    public class SceneSwitchProgress

    Properties

    DoneClients

    List of clientIds of those clients that is done loading the scene.

    Declaration
    public List<ulong> DoneClients { get; }
    Property Value
    Type Description
    List<ulong>

    IsAllClientsDoneLoading

    If all clients are done loading the scene, at the moment of completed.

    Declaration
    public bool IsAllClientsDoneLoading { get; }
    Property Value
    Type Description
    bool

    IsCompleted

    Is this scene switch progresses completed, all clients are done loading the scene or a timeout has occured.

    Declaration
    public bool IsCompleted { get; }
    Property Value
    Type Description
    bool

    TimeAtInitiation

    The NetworkTime time at the moment the scene switch was initiated by the server.

    Declaration
    public float TimeAtInitiation { get; }
    Property Value
    Type Description
    float

    Events

    OnClientLoadedScene

    The callback invoked when a client is done loading the scene.

    Declaration
    public event SceneSwitchProgress.OnClientLoadedSceneDelegate OnClientLoadedScene
    Event Type
    Type Description
    SceneSwitchProgress.OnClientLoadedSceneDelegate

    OnComplete

    The callback invoked when the switch scene progress is completed. Either by all clients done loading the scene or by time out.

    Declaration
    public event SceneSwitchProgress.OnCompletedDelegate OnComplete
    Event Type
    Type Description
    SceneSwitchProgress.OnCompletedDelegate
    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)