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 Checkout(assets: AssetList, mode: CheckoutMode): Task;
static Task Checkout(AssetList assets, CheckoutMode mode);
static def Checkout(assets as AssetList, mode as CheckoutMode) as Task
static function Checkout(assets: string[], mode: CheckoutMode): Task;
static Task Checkout(string[] assets, CheckoutMode mode);
static def Checkout(assets as string[], mode as CheckoutMode) as Task
static function Checkout(assets: Object[], mode: CheckoutMode): Task;
static Task Checkout(Object[] assets, CheckoutMode mode);
static def Checkout(assets as Object[], mode as CheckoutMode) as Task
static function Checkout(asset: Asset, mode: CheckoutMode): Task;
static Task Checkout(Asset asset, CheckoutMode mode);
static def Checkout(asset as Asset, mode as CheckoutMode) as Task
static function Checkout(asset: string, mode: CheckoutMode): Task;
static Task Checkout(string asset, CheckoutMode mode);
static def Checkout(asset as string, mode as CheckoutMode) as Task
static function Checkout(asset: Object, mode: CheckoutMode): Task;
static Task Checkout(Object asset, CheckoutMode mode);
static def Checkout(asset as Object, mode as CheckoutMode) as Task

Parameters

assetsList of assets to checkout.
modeTell the Provider to checkout the asset, the .meta file or both.
assetAsset to checkout.

Description

Checkout an asset or list of asset from the version control system.

Some version control systems like Perforce requires an asset to be checked out before it can be edited.