Interface ISceneProvider | Addressables | 1.13.1
docs.unity3d.com
    Show / Hide Table of Contents

    Interface ISceneProvider

    Interface for scene providers.

    Namespace: UnityEngine.ResourceManagement.ResourceProviders
    Syntax
    public interface ISceneProvider

    Methods

    ProvideScene(ResourceManager, IResourceLocation, LoadSceneMode, Boolean, Int32)

    Load a scene at a specified resource location.

    Declaration
    AsyncOperationHandle<SceneInstance> ProvideScene(ResourceManager resourceManager, IResourceLocation location, LoadSceneMode loadMode, bool activateOnLoad, int priority)
    Parameters
    Type Name Description
    ResourceManager resourceManager

    The resource manager to use for loading dependencies.

    IResourceLocation location

    The location of the scene.

    LoadSceneMode loadMode

    Load mode for the scene.

    Boolean activateOnLoad

    If true, the scene is activated as soon as it finished loading. Otherwise it needs to be activated via the returned SceneInstance object.

    Int32 priority

    The loading priority for the load.

    Returns
    Type Description
    AsyncOperationHandle<SceneInstance>

    An operation handle for the loading of the scene. The scene is wrapped in a SceneInstance object to support delayed activation.

    ReleaseScene(ResourceManager, AsyncOperationHandle<SceneInstance>)

    Release a scene.

    Declaration
    AsyncOperationHandle<SceneInstance> ReleaseScene(ResourceManager resourceManager, AsyncOperationHandle<SceneInstance> sceneLoadHandle)
    Parameters
    Type Name Description
    ResourceManager resourceManager

    The resource manager to use for loading dependencies.

    AsyncOperationHandle<SceneInstance> sceneLoadHandle

    The operation handle used to load the scene.

    Returns
    Type Description
    AsyncOperationHandle<SceneInstance>

    An operation handle for the unload.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023