docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct EntityStorageInfoLookup

    A [NativeContainer] that provides access to information about how Entities are stored. Entity.

    Namespace: Unity.Entities
    Assembly: Unity.Entities.dll
    Syntax
    [NativeContainer]
    [NativeContainerIsReadOnly]
    public struct EntityStorageInfoLookup
    Remarks

    EntityStorageInfoLookup is a native container that provides access to information about how Entities are stored. You can use EntityStorageInfoLookup to look up data associated with one entity while iterating over a different set of entities.

    To get a EntityStorageInfoLookup, call GetEntityStorageInfoLookup().

    Pass a EntityStorageInfoLookup container to a job by defining a public field of the appropriate type in your IJob implementation. You can safely read from EntityStorageInfoLookup in any job, and the EntityStorageInfoLookup will never write data.

    If you would like to access an entity's storage information outside of a job, consider using the EntityManager methods GetStorageInfo(Entity) instead, to avoid the overhead of creating a EntityStorageInfoLookup object.

    Properties

    Name Description
    this[Entity]

    Gets an EntityStorageInfo for the specified entity.

    Methods

    Name Description
    Exists(Entity)

    Reports whether the specified Entity instance still refers to a valid entity.

    Update(SystemBase)

    When a EntityStorageInfoLookup is cached by a system across multiple system updates, calling this function inside the system's OnUpdate() method performs the minimal incremental updates necessary to make the object safe to use.

    Update(ref SystemState)

    When a EntityStorageInfoLookup is cached by a system across multiple system updates, calling this function inside the system's OnUpdate() method performs the minimal incremental updates necessary to make the object safe to use.

    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)