Class DefaultWorldInitialization | Project Tiny | 0.25.0-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class DefaultWorldInitialization

    Inheritance
    Object
    DefaultWorldInitialization
    Namespace: Unity.Entities
    Syntax
    public static class DefaultWorldInitialization

    Methods

    AddSystem(World, ComponentSystemBase, Boolean)

    Call this to add a System that was manually constructed; normally these Systems are marked with [DisableAutoCreation].

    Declaration
    public static void AddSystem(World world, ComponentSystemBase system, bool addSystemToGroup)
    Parameters
    Type Name Description
    World world
    ComponentSystemBase system
    Boolean addSystemToGroup

    AddSystemsToRootLevelSystemGroups(World, List<Type>)

    Adds the list of systems to the world by injecting them into the root level system groups (InitializationSystemGroup, SimulationSystemGroup and PresentationSystemGroup). If a null system list is passed, all systems are automatically added.

    Declaration
    public static void AddSystemsToRootLevelSystemGroups(World world, List<Type> systems = null)
    Parameters
    Type Name Description
    World world
    List<Type> systems

    GetAllSystems(WorldSystemFilterFlags, Boolean)

    Calculates a list of all systems filtered with WorldSystemFilterFlags, [DisableAutoCreation] etc.

    Declaration
    public static List<Type> GetAllSystems(WorldSystemFilterFlags filterFlags, bool requireExecuteAlways = false)
    Parameters
    Type Name Description
    WorldSystemFilterFlags filterFlags
    Boolean requireExecuteAlways

    Optionally require that [ExecuteAlways] is present on the system. This is used when creating edit mode worlds.

    Returns
    Type Description
    List<Type>

    The list of filtered systems

    Initialize(String, Boolean)

    Initializes the default world or runs ICustomBootstrap if one is available. ComponentSystems will be created and sorted into the high level ComponentSystemGroups.

    Declaration
    public static World Initialize(string defaultWorldName, bool editor = false)
    Parameters
    Type Name Description
    String defaultWorldName

    The name of the world that will be created unless there is a custom bootstrap.

    Boolean editor
    Returns
    Type Description
    World
    See Also
    InitializeWorld(String)
    AddSystemsToRootLevelSystemGroups(World, List<Type>)

    InitializeWorld(String)

    Initialize the World object. See Initialize(String, Boolean) for use.

    Declaration
    public static World InitializeWorld(string worldName)
    Parameters
    Type Name Description
    String worldName
    Returns
    Type Description
    World
    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