docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method AddSystemManaged

    AddSystemManaged<T>(T)

    Adds an existing system instance to this World

    Declaration
    public T AddSystemManaged<T>(T system) where T : ComponentSystemBase
    Parameters
    Type Name Description
    T system

    The existing system instance to add

    Returns
    Type Description
    T

    The input system

    Type Parameters
    Name Description
    T

    The system type

    Remarks

    Important: This function creates a sync point, which means that the EntityManager waits for all currently running Jobs to complete before adding the system, and no additional Jobs can start before the function is finished. A sync point can cause a drop in performance because the ECS framework may not be able to make use of the processing power of all available cores.

    Note: This system reference is not guaranteed to be safe to use. If the system or world is destroyed then the OnDestroy and cleanup functionality will have been called for this system.

    If possible, using CreateSystem(Type) is preferred, and instead of public member data, component data is recommended for system level data that needs to be shared between systems or externally to them. This defines a data protocol for the system which is separated from the system functionality.

    Private member data which is only used internally to the system is recommended.

    Keep in mind using a managed reference for systems

    • encourages coupling of data and functionality
    • couples data to the system type with no direct path to decouple
    • does not provide lifetime or thread safety guarantees for data access
    • does not provide lifetime or thread safety guarantees for system access through the returned managed reference

    If T has not been registered with the TypeManager, this method will register it before adding the system.

    Exceptions
    Type Condition
    Exception

    Thrown if a system of type T already exists in this World

    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)