Unity - Scripting API: VersionControl.Provider.CheckoutIsValid
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.
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.
Declaration
public static bool CheckoutIsValid(AssetList assets);
Declaration
public static bool CheckoutIsValid(Asset asset);
Parameters
| Parameter | Description |
|---|---|
| assets | List of assets. |
| asset | Single asset. |
| mode | Specify to check only asset files, meta files or both. |
Description
Given an asset or a list of assets this function returns true if Provider.Checkout is a valid task to perform on at least one of the given assets.
The CheckoutMode option can be used to narrow down the asset list to a specific type. For example: to only check whether meta files can be checked out and to ignore their asset file states, the CheckoutMode.Meta must be used.
The code above will check the "ExampleAsset.cs" meta file and return true to the console if It can be checked out.