Version: 2020.2
LanguageEnglish
  • C#

AssetDatabase.CanOpenForEdit

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 bool CanOpenForEdit(Object assetObject, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);
public static bool CanOpenForEdit(string assetOrMetaFilePath, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);
public static bool CanOpenForEdit(Object assetObject, out string message, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);
public static bool CanOpenForEdit(string assetOrMetaFilePath, out string message, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

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 available 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.

Returns

bool True if the asset is considered available for edit by the selected version control system.

Description

Query whether an Asset file can be opened for editing in version control and is not exclusively locked by another user or otherwise unavailable.


public static void CanOpenForEdit(string[] assetOrMetaFilePaths, List<string> outNotEditablePaths, StatusQueryOptions statusQueryOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

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.

Description

Query which of the provided Asset files can be opened for editing in version control and are not remotely locked or otherwise unavailable.

This variant of the CanOpenForEdit function can query multiple Asset paths at once. It writes paths for Assets that are not 'available for edit' into the outNotEditablePaths list.