Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

VersionControl.Provider.Checkout

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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