Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

AssetDatabase.IsOpenForEdit

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

Declaration

public static bool IsOpenForEdit(Object assetObject, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

Parameter Description
assetObject The asset object to check.
statusOptions How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.

Returns

bool True if the version control system considers the asset open for editing. Otherwise, false.

Description

Checks whether an asset object is open for editing in version control.

Some version control systems only let one user at a time edit certain types of file, to avoid conflicts. In that case, you must open the file for editing, also known as checking it out, before you can edit it. Use this method to check whether a file is open for editing.

Paths outside the project folder, or in folders that aren't under version control such as Library or Temp, are always open for editing. Paths in packages that aren't local are never open for editing. When no version control system is active, all paths inside the project are open for editing. When one is active, which files count as open depends on the system. For example, in Perforce, files that you added or checked out locally are open for editing.

To check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.


Declaration

public static bool IsOpenForEdit(string assetOrMetaFilePath, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

Parameter Description
assetOrMetaFilePath The project-relative path of the asset file or its .meta file.
statusOptions How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.

Returns

void True if the version control system considers the asset open for editing. Otherwise, false.

Description

Checks whether the asset at a path is open for editing in version control.

Some version control systems only let one user at a time edit certain types of file, to avoid conflicts. In that case, you must open the file for editing, also known as checking it out, before you can edit it. Use this method to check whether a file is open for editing.

Paths outside the project folder, or in folders that aren't under version control such as Library or Temp, are always open for editing. Paths in packages that aren't local are never open for editing. When no version control system is active, all paths inside the project are open for editing. When one is active, which files count as open depends on the system. For example, in Perforce, files that you added or checked out locally are open for editing.

To check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.


Declaration

public static bool IsOpenForEdit(Object assetObject, out string message, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

Parameter Description
assetObject The asset object to check.
message When the method returns, contains the reason why the asset isn't available for editing, if there is one.
statusOptions How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.

Returns

void True if the version control system considers the asset open for editing. Otherwise, false.

Description

Checks whether an asset object is open for editing in version control and gets the reason if it isn't.

Some version control systems only let one user at a time edit certain types of file, to avoid conflicts. In that case, you must open the file for editing, also known as checking it out, before you can edit it. Use this method to check whether a file is open for editing.

Paths outside the project folder, or in folders that aren't under version control such as Library or Temp, are always open for editing. Paths in packages that aren't local are never open for editing. When no version control system is active, all paths inside the project are open for editing. When one is active, which files count as open depends on the system. For example, in Perforce, files that you added or checked out locally are open for editing.

To check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.


Declaration

public static bool IsOpenForEdit(string assetOrMetaFilePath, out string message, StatusQueryOptions statusOptions = StatusQueryOptions.UseCachedIfPossible);

Parameters

Parameter Description
assetOrMetaFilePath The project-relative path of the asset file or its .meta file.
message When the method returns, contains the reason why the asset isn't available for editing, if there is one.
statusOptions How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.

Returns

void True if the version control system considers the asset open for editing. Otherwise, false.

Description

Checks whether the asset at a path is open for editing in version control and gets the reason if it isn't.

Some version control systems only let one user at a time edit certain types of file, to avoid conflicts. In that case, you must open the file for editing, also known as checking it out, before you can edit it. Use this method to check whether a file is open for editing.

Paths outside the project folder, or in folders that aren't under version control such as Library or Temp, are always open for editing. Paths in packages that aren't local are never open for editing. When no version control system is active, all paths inside the project are open for editing. When one is active, which files count as open depends on the system. For example, in Perforce, files that you added or checked out locally are open for editing.

To check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.


Declaration

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

Parameters

Parameter Description
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 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.