Class DisableAutoCreationAttribute | Entities | 0.10.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Class DisableAutoCreationAttribute

    Prevents a system from being automatically created and run.

    Inheritance
    Object
    Attribute
    DisableAutoCreationAttribute
    Namespace: Unity.Entities
    Syntax
    [AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class)]
    public sealed class DisableAutoCreationAttribute : Attribute, _Attribute
    Remarks

    By default, all systems (classes derived from ComponentSystemBase) are automatically discovered, instantiated, and added to the default World when that World is created.

    Add this attribute to a system class that you do not want created automatically. Note that the attribute is not inherited by any subclasses.

    using Unity.Entities;
    
    [DisableAutoCreation]
    public class CustomSystem : JobComponentSystem
    { // Implementation... }

    You can also apply this attribute to an entire assembly to prevent any system class in that assembly from being created automatically. This is useful for test assemblies containing many systems that expect to be tested in isolation.

    To declare an assembly attribute, place it in any C# file compiled into the assembly, outside the namespace declaration:

    using Unity.Entities;
    
    [assembly: DisableAutoCreation]
    namespace Tests{}
    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