Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Provider.Checkout

Switch to Manual
public static function Checkout(assets: VersionControl.AssetList, mode: VersionControl.CheckoutMode): VersionControl.Task;
public static function Checkout(assets: string[], mode: VersionControl.CheckoutMode): VersionControl.Task;
public static function Checkout(assets: Object[], mode: VersionControl.CheckoutMode): VersionControl.Task;
public static function Checkout(asset: VersionControl.Asset, mode: VersionControl.CheckoutMode): VersionControl.Task;
public static function Checkout(asset: string, mode: VersionControl.CheckoutMode): VersionControl.Task;
public static function Checkout(asset: Object, mode: VersionControl.CheckoutMode): VersionControl.Task;

Parameters

assets List of assets to checkout.
mode Tell the Provider to checkout the asset, the .meta file or both.
asset Asset 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.