Legacy Documentation: Version 5.6 (Go to current version)
  • C#
  • JS

Script language

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


class in UnityEngine.VR.WSA.Sharing

Suggest a change


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.


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.




A batch of WorldAnchors which can be exported and imported between apps.


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

Public Functions

AddWorldAnchorAdds a WorldAnchor to the batch with the specified identifier.
DisposeCleans up the WorldAnchorTransferBatch and releases memory.
GetAllIdsGets all of the identifiers currently mapped in this WorldAnchorTransferBatch.
LockObjectLocks the provided GameObject to the world by loading and applying the WorldAnchor from the TransferBatch for the provided id.

Static Functions

ExportAsyncExports the input WorldAnchorTransferBatch into a byte array which can be passed to WorldAnchorTransferBatch.ImportAsync to restore the original WorldAnchorTransferBatch.
ImportAsyncImports the provided bytes into a WorldAnchorTransferBatch.


DeserializationCompleteDelegateThe handler for when deserialization has completed.
SerializationCompleteDelegateThe handler for when serialization is completed.
SerializationDataAvailableDelegateThe handler for when some data is available from serialization.