⚠ Preview docs — built from the develop branch and may be unstable. Go to the stable docs.

enum SpatialStatus

Whether the things you’ve asked of a spatial entity have gone through, like creating an anchor or persisting it. Failure states are negative and healthy ones positive, so status < 0 catches every failure. This is separate from tracking, so an entity can be tracked and usable while a persist is still Pending. Entities the system discovers on its own, like planes, are Ready unless you ask something of them.

Enum Values

   
Failed The entity couldn’t be created, or storage doesn’t have the id it was looked up by. It shows up in the removed list with this status for its final frame.
None Not a valid entity.
Partial The entity exists, but at least one thing you asked of it failed, like a persist. Check its components to see what’s missing, and making a new request clears this.
Pending Something you asked of this entity is still in progress, like creation, loading it by persist id, or a persist that’s waiting on the system.
Ready Nothing you’ve asked of this entity is still in progress, and nothing failed.




Found an issue with these docs, or have some additional questions? Create an Issue on Github!