Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Provider.PreCheckoutCallback

Delegate for a user-supplied callback to be called before Version Control Checkout.
Read time 1 minuteLast updated 5 days ago

Definition

public delegate bool Provider.PreCheckoutCallback(AssetList list, ref string changesetID, ref string changesetDescription)

Remarks

A PreCheckoutCallback may be set to enable the following: Permit the check out by returning true from the callback. Prevent the check out by returning false from the callback. Modify the list of Assets to be checked out (you may wish to prevent certain Assets being checked out, or ensure that certain Assets are checked out). Redirect the check out to an existing changeset. Create a new changeset to check the Assets out in.
Notes: The AssetList is absolute - Assets and/or their Meta Files will not be automatically added after this callback returns. Setting both a changesetID and a changesetDescription should ideally allow an existing changeset to be renamed (to change its description) but this is not currently supported. Attempting to set a changesetDescription when the VCS provider does not support changesets will raise an error. Check for support by calling hasChangelistSupport. You must not call any code inside this callback that results in a further check out operation being created, as this will lead to potentially infinite recursion. Be aware of Domain Reloads. If your Assemblies are reloaded at any point then you need to set Provider.preCheckoutCallback again with your chosen callback.