Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

static function Lock(assets: AssetList, locked: bool): Task;
static Task Lock(AssetList assets, bool locked);
static def Lock(assets as AssetList, locked as bool) as Task
static function Lock(asset: Asset, locked: bool): Task;
static Task Lock(Asset asset, bool locked);
static def Lock(asset as Asset, locked as bool) as Task

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.