IsOpenForEdit
Query which of the provided Asset files are open for editing in version control.
Read time 5 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
IsOpenForEdit(string[], List<string>, StatusQueryOptions)
Query which of the provided Asset files are open for editing in version control.
public static void IsOpenForEdit(string[] assetOrMetaFilePaths, List<string> outNotEditablePaths, StatusQueryOptions statusQueryOptions = StatusQueryOptions.UseCachedIfPossible)
Parameters
Paths to Assets or their .meta files, relative to the project folder.
Destination list of non-editable Asset paths.
Specifies how Unity should query the version control system. The default value is StatusQueryOptions.UseCachedIfPossible.
Remarks
This variant of the function can query multiple Asset paths at once. It writes paths for Assets that are not 'open for edit' into the list.
IsOpenForEditoutNotEditablePathsIsOpenForEdit(Object, StatusQueryOptions)
Checks whether an asset object is open for editing in version control.
public static bool IsOpenForEdit(Object assetObject, StatusQueryOptions statusOptions)
Parameters
The asset object to check.
How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.
Returns
Type | Description |
|---|---|
| bool | True if the version control system considers the asset open for editing. Otherwise, false. |
Remarks
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 or , 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.
LibraryTempTo check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.
IsOpenForEdit(string, StatusQueryOptions)
Checks whether the asset at a path is open for editing in version control.
public static bool IsOpenForEdit(string assetOrMetaFilePath, StatusQueryOptions statusOptions)
Parameters
The project-relative path of the asset file or its .meta file.
How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.
Returns
Type | Description |
|---|---|
| bool | True if the version control system considers the asset open for editing. Otherwise, false. |
Remarks
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 or , 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.
LibraryTempTo check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.
IsOpenForEdit(Object, string, StatusQueryOptions)
Checks whether an asset object is open for editing in version control and gets the reason if it isn't.
public static bool IsOpenForEdit(Object assetObject, out string message, StatusQueryOptions statusOptions)
Parameters
The asset object to check.
When the method returns, contains the reason why the asset isn't available for editing, if there is one.
How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.
Returns
Type | Description |
|---|---|
| bool | True if the version control system considers the asset open for editing. Otherwise, false. |
Remarks
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 or , 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.
LibraryTempTo check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.
IsOpenForEdit(string, string, StatusQueryOptions)
Checks whether the asset at a path is open for editing in version control and gets the reason if it isn't.
public static bool IsOpenForEdit(string assetOrMetaFilePath, out string message, StatusQueryOptions statusOptions)
Parameters
The project-relative path of the asset file or its .meta file.
When the method returns, contains the reason why the asset isn't available for editing, if there is one.
How to query the version control system. These options affect the speed and accuracy of the query. The default value is StatusQueryOptions.UseCachedIfPossible.
Returns
Type | Description |
|---|---|
| bool | True if the version control system considers the asset open for editing. Otherwise, false. |
Remarks
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 or , 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.
LibraryTempTo check the .meta file of an asset, use AssetDatabase.IsMetaFileOpenForEdit.