Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

Provider.Lock

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 static method Lock(assets: VersionControl.AssetList, locked: bool): VersionControl.Task;
public static VersionControl.Task Lock(VersionControl.AssetList assets, bool locked);
public static method Lock(asset: VersionControl.Asset, locked: bool): VersionControl.Task;
public static VersionControl.Task Lock(VersionControl.Asset asset, bool locked);

Parameters

assetsList of assets to lock/unlock.
lockedTrue to lock assets, false to unlock assets.
assetAsset to lock/unlock.

Description

Attempt to lock an asset for exclusive editing.

Depening on version control system and server setup this might be an exclusive lock preventing other people from even modifing the asset or or it might simple prevent other people from submitting the asset to the version control server.