IsMetaFileOpenForEdit
Query whether an asset's metadata (.meta) file is open for edit in version control.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
IsMetaFileOpenForEdit(Object, StatusQueryOptions)
Query whether an asset's metadata (.meta) file is open for edit in version control.
public static bool IsMetaFileOpenForEdit(Object assetObject, StatusQueryOptions statusOptions)
Parameters
Object representing the asset whose metadata status you wish to query.
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
Type | Description |
|---|---|
| bool | True if the asset's metadata is considered open for edit by the selected version control system. |
Remarks
Your version control system may be configured to only allow a single user at a time to edit certain types of file, 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.
Additional Resources: AssetDatabase.IsOpenForEdit, StatusQueryOptions.
IsMetaFileOpenForEdit(Object, string, StatusQueryOptions)
Query whether an asset's metadata (.meta) file is open for edit in version control.
public static bool IsMetaFileOpenForEdit(Object assetObject, out string message, StatusQueryOptions statusOptions)
Parameters
Object representing the asset whose metadata status you wish to query.
Returns a reason for the asset metadata not being open for edit.
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
Type | Description |
|---|---|
| bool | True if the asset's metadata is considered open for edit by the selected version control system. |
Remarks
Your version control system may be configured to only allow a single user at a time to edit certain types of file, 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.
Additional Resources: AssetDatabase.IsOpenForEdit, StatusQueryOptions.