Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Lock

Attempt to lock an asset for exclusive editing.
Read time 1 minuteLast updated 6 days ago

Definition

Lock(AssetList, bool)

Attempt to lock an asset for exclusive editing.
public static Task Lock(AssetList assets, bool locked)

Parameters

assets

List of assets to lock/unlock.

locked

True to lock assets, false to unlock assets.

Returns

Type

Description

Task

Remarks

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).

Examples

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(); }}

Lock(Asset, bool)

Attempt to lock an asset for exclusive editing.
public static Task Lock(Asset asset, bool locked)

Parameters

asset

Asset to lock/unlock.

locked

True to lock assets, false to unlock assets.

Returns

Type

Description

Task

Remarks

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).

Examples

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(); }}