docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SceneEvent

    Used for local notifications of various scene events. The OnSceneEvent of delegate type NetworkSceneManager.SceneEventDelegate uses this class to provide scene event status.
    Note: This is only when EnableSceneManagement is enabled.
    *** Do not start new scene events within scene event notification callbacks.
    See also:
    SceneEventType

    Inheritance
    object
    SceneEvent
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Unity.Netcode
    Assembly: solution.dll
    Syntax
    public class SceneEvent

    Fields

    Name Description
    AsyncOperation

    The AsyncOperation returned by SceneManager
    This is set for the following SceneEventTypes:

    • Load
    • Unload
    ClientId

    The client identifier can vary depending upon the following conditions:

    1. SceneEventTypes that always set the ClientId to the local client identifier, are initiated (and processed locally) by the server-host, and sent to all clients to be processed.
      • Load
      • Unload
      • Synchronize
      • ReSynchronize
    2. Events that always set the ClientId to the local client identifier, are initiated (and processed locally) by a client or server-host, and if initiated by a client will always be sent to and processed on the server-host:
      • LoadComplete
      • UnloadComplete
      • SynchronizeComplete
    3. Events that always set the ClientId to the ServerId:
      • LoadEventCompleted
      • UnloadEventCompleted
    ClientsThatCompleted

    List of clients that completed a loading or unloading event.
    This is set for the following SceneEventTypes:

    • LoadEventCompleted
    • UnloadEventCompleted
    ClientsThatTimedOut

    List of clients that timed out during a loading or unloading event.
    This is set for the following SceneEventTypes:

    • LoadEventCompleted
    • UnloadEventCompleted
    LoadSceneMode

    If applicable, this reflects the type of scene loading or unloading that is occurring.
    This is set for the following SceneEventTypes:

    • Load
    • Unload
    • LoadComplete
    • UnloadComplete
    • LoadEventCompleted
    • UnloadEventCompleted
    Scene

    When a scene is loaded, the Scene structure is returned.
    This is set for the following SceneEventTypes:

    • LoadComplete
    SceneEventType

    Will always be set to the current SceneEventType

    SceneName

    This will be set to the scene name that the event pertains to.
    This is set for the following SceneEventTypes:

    • Load
    • Unload
    • LoadComplete
    • UnloadComplete
    • LoadEventCompleted
    • UnloadEventCompleted
    In This Article
    Back to top
    Copyright © 2024 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)