Version: 2022.3
LanguageEnglish
  • C#

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

Declaration

public static VersionControl.Task Lock(VersionControl.AssetList assets, bool locked);

Declaration

public static VersionControl.Task Lock(VersionControl.Asset asset, bool locked);

Parameters

asset Asset to lock/unlock.
assets List of assets to lock/unlock.
locked True to lock assets, false to unlock assets.

Description

Attempt to lock an asset for exclusive editing.

Depending on version control system and server setup this might be an exclusive lock preventing other people from even modifing the asset (for example: Plastic SCM or Git) or it might simply prevent other people from submitting the asset to the version control server (Perforce).

using System.Collections.Generic;
using UnityEditor;
using UnityEditor.VersionControl;
using UnityEngine;

public class EditorScript : MonoBehaviour { [MenuItem("Version Control/Lock")] public static void ExampleLock() { AssetList assets = new AssetList(); assets.Add(Provider.GetAssetByPath("Assets/ExampleAsset.cs")); Task t1 = Provider.Checkout(assets, CheckoutMode.Exact); t1.Wait(); Task t2 = Provider.Lock(assets, locked: true); t2.Wait(); } }
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961