docs.unity.cn
    Show / Hide Table of Contents

    Class SceneSystem

    High level API for loading and unloading scenes

    Inheritance
    Object
    ComponentSystemBase
    ComponentSystem
    SceneSystem
    Inherited Members
    ComponentSystem.PostUpdateCommands
    ComponentSystem.InitEntityQueryCache(Int32)
    ComponentSystem.Entities
    ComponentSystem.Update()
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.SystemHandleUntyped
    ComponentSystemBase.Time
    ComponentSystemBase.OnCreateForCompiler()
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.OnDestroy()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(Boolean)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(Boolean)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetDynamicSharedComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.GetComponentDataFromEntity<T>(Boolean)
    ComponentSystemBase.GetBufferFromEntity<T>(Boolean)
    ComponentSystemBase.GetStorageInfoFromEntity()
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.TryGetSingleton<T>(T)
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.TryGetSingletonEntity<T>(Entity)
    ComponentSystemBase.GetEntityQuery(ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(EntityQueryDesc[])
    Namespace: Unity.Scenes
    Syntax
    [ExecuteAlways]
    [UpdateInGroup(typeof(SceneSystemGroup))]
    public class SceneSystem : ComponentSystem

    Properties

    Name Description
    BuildConfigurationGUID

    Methods

    Name Description
    GetSceneEntity(Hash128)

    Find the scene given a guid. This will only return the first matching scene.

    GetSceneGUID(String)

    Get the guid for a scene path or name. This is a slow method - it is best to use the guid directly.

    IsSceneLoaded(Entity)

    Check if a scene or subscene is loaded.

    IsSectionLoaded(Entity)

    Check if a section of a subscene is loaded.

    LoadPrefabAsync(EntityPrefabReference, SceneSystem.LoadParameters)

    Load a prefab by its weak reference id. A PrefabRoot component is added to the returned entity when the load completes.

    LoadSceneAsync(Entity, SceneSystem.LoadParameters)
    LoadSceneAsync(Hash128, SceneSystem.LoadParameters)

    Load a scene or prefab by its asset GUID. When loading a prefab a PrefabRoot component is added to the scene entity when the load completes.

    LoadSceneAsync(EntitySceneReference, SceneSystem.LoadParameters)

    Load a scene by its weak reference id.

    OnCreate()
    OnUpdate()
    UnloadScene(Entity, SceneSystem.UnloadParameters)

    Unload the scene.

    UnloadScene(Hash128, SceneSystem.UnloadParameters)

    Unload a SubScene by GUID. This will only unload the first matching scene.

    Extension Methods

    ComponentSystemBaseManagedComponentExtensions.GetSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.SetSingleton<T>(ComponentSystemBase, T)
    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Wednesday, July 6, 2022
    Terms of use