Class WriteGroupAttribute | Entities | 0.13.0-preview.24
docs.unity3d.com
    Show / Hide Table of Contents

    Class WriteGroupAttribute

    [WriteGroup] Can exclude components which are unknown at the time of creating the query that have been declared to write to the same component.

    This allows for extending systems of components safely without editing the previously existing systems.

    The goal is to have a way for systems that expect to transform data from one set of components (inputs) to another (output[s]) be able to declare that explicit transform, and they exclusively know about one set of inputs. If there are other inputs that want to write to the same output, the query shouldn't match because it's a nonsensical/unhandled setup. It's both a way to guard against nonsensical components (having two systems write to the same output value), and a way to "turn off" existing systems/queries by putting a component with the same write lock on an entity, letting another system handle it.

    Inheritance
    Object
    Attribute
    WriteGroupAttribute
    Namespace: Unity.Entities
    Syntax
    [AttributeUsage(AttributeTargets.Struct, AllowMultiple = true)]
    public class WriteGroupAttribute : Attribute, _Attribute

    Constructors

    WriteGroupAttribute(Type)

    Declaration
    public WriteGroupAttribute(Type targetType)
    Parameters
    Type Name Description
    Type targetType

    Fields

    TargetType

    Declaration
    public Type TargetType
    Field Value
    Type Description
    Type
    In This Article
    • Constructors
      • WriteGroupAttribute(Type)
    • Fields
      • TargetType
    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