Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

Provider.Checkout

Other Versions
Leave feedback
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

Submission failed

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

Close

Cancel

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

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.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2017.3-002A. Built: 2018-04-04.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information