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.


    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
    • Properties
    • Methods
    Back to top
    Copyright © 2025 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)