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

Script language

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

WorldAnchorTransferBatch.LockObject

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

public function LockObject(id: string, go: GameObject): VR.WSA.WorldAnchor;
public VR.WSA.WorldAnchor LockObject(string id, GameObject go);

Parameters

id The identifier for the WorldAnchor to load and apply to the GameObject.
go The GameObject to apply the WorldAnchor to. If the GameObject already has a WorldAnchor, it will be updated.

Returns

WorldAnchor The loaded WorldAnchor or null if the id does not map to a WorldAnchor.

Description

Locks the provided GameObject to the world by loading and applying the WorldAnchor from the TransferBatch for the provided id.