Persistence is a system for saving World Anchor states across multiple runs of the same application. This can be thought of as a “save game” functionality for physical locations in the real world. An example of this is remembering where a game board is placed in the world when the application re-launches.
The WorldAnchorStore
provides basic functionality for saving and loading World Anchors. Retrieve a WorldAnchorStore
by calling WorldAnchorStore.GetAsync
and providing it with a callback. Your callback saves the WorldAnchorStore
returned so that it can be used for future operations.
To save an existing World Anchor, give it a name and call the Save
function on the WorldAnchorStore
. See an example below:
private void SaveAnchor()
{
if (!this.savedAnchor) // only save this once
{
this.savedAnchor = this.MyWorldAnchorStore.Save("MyAnchor", MyWorldAnchor);
if (!this.savedAnchor)
{
// Anchor failed to save to the store.
// Handle errors here.
}
}
}
Loading is essentially a reflection of the above:
private void LoadAnchor()
{
this.savedAnchor = this.Load("MyAnchor", MyWorldAnchor);
if (!this.savedAnchor)
{
// An anchor with that name wasn't saved to the store.
// Handle errors here.
}
}
To remove an anchor from the store, call the Delete method on the WorldAnchorStore. To remove all anchors from the store, call the Clear method.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!