docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DisableAutoCreationAttribute

    Prevents a system from being automatically created and run.

    Inheritance
    object
    Attribute
    DisableAutoCreationAttribute
    Namespace: Unity.Entities
    Assembly: solution.dll
    Syntax
    [AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct, Inherited = false)]
    public sealed class DisableAutoCreationAttribute : Attribute
    Remarks

    By default, all systems (classes derived from ComponentSystemBase or ISystem) 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 partial class CustomSystem : SystemBase
    { // 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{}

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    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)