assetObject | Object representing the asset whose status you wish to query. |
assetOrMetaFilePath | Path to the asset file or its .meta file on disk, relative to project folder. |
message | Returns a reason for the asset not being open for edit. |
statusOptions | Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. Default is StatusQueryOptions.UseCachedIfPossible. |
bool True if the asset is considered open for edit by the selected version control system.
Query whether an Asset file is open for editing in version control.
Your version control system may be configured to only allow a single user at a time to edit certain types of files, to avoid conflicts that arise when multiple users edit a file at the same time. In this case a user must 'open' that file for editing (also known as 'checking out') to ensure that they have permission to edit the file. Use this function to query the 'open for edit' status of a file in a version control system that supports it.
File paths that are outside of Unity project folder, or not under version controlled folders (for example, "Library" or "Temp"),
are always considered open for editing. IsOpenForEdit
returns true
for these paths.
File paths that refer to non-local Package folders are always considered to be non-editable. IsOpenForEdit
returns false
for these paths.
When no version control system is active, then file paths inside the project are all considered open for editing.
When a version control system is active, then for example under Perforce VCS, "added" and "checked out locally" files
are considered open for editing, and other files are not.
See Also: AssetDatabase.IsMetaFileOpenForEdit, StatusQueryOptions, AssetDatabase.MakeEditable.
assetOrMetaFilePaths | Paths to Assets or their .meta files, relative to the project folder. |
outNotEditablePaths | Destination list of non-editable Asset paths. |
statusQueryOptions | Specifies how Unity should query the version control system. The default value is StatusQueryOptions.UseCachedIfPossible. |
Query which of the provided Asset files are open for editing in version control.
This variant of the IsOpenForEdit
function can query multiple Asset paths at once. It writes paths for Assets that are not 'open for edit' into the outNotEditablePaths
list.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.