Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

WorldAnchorStore

class in UnityEngine.VR.WSA.Persistence

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The storage object for persisted WorldAnchors.

Variables

anchorCount(Read Only) Gets the number of persisted world anchors in this WorldAnchorStore.

Public Functions

ClearClears all persisted WorldAnchors.
DeleteDeletes a persisted WorldAnchor from the store.
GetAllIdsGets all of the identifiers of the currently persisted WorldAnchors.
LoadLoads a WorldAnchor from disk for given identifier and attaches it to the GameObject. If the GameObject has a WorldAnchor, that WorldAnchor will be updated. If the anchor is not found, null will be returned and the GameObject and any existing WorldAnchor attached to it will not be modified.
SaveSaves the provided WorldAnchor with the provided identifier. If the identifier is already in use, the method will return false.

Static Functions

GetAsyncGets the WorldAnchorStore instance.

Delegates

GetAsyncDelegateThe handler for when getting the WorldAnchorStore from GetAsync.