EntityStorageInfoLookup
A [NativeContainer] that provides access to information about how Entities are stored. Entity.
Read time 1 minuteLast updated a day ago
Definition
- Type: Struct
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
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 ComponentSystemBase.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 EntityManager.GetStorageInfo instead, to avoid the overhead of creating a EntityStorageInfoLookup object.
Properties
Property | Description |
|---|---|
| this[] | Gets an EntityStorageInfo for the specified entity. |
Methods
Method | Description |
|---|---|
| Exists | Reports whether the specified Entity instance still refers to a valid entity. |
| Update | 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. |