Version: 2023.2
LanguageEnglish
  • C#

Provider.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(VersionControl.Asset asset);

Parameters

asset Asset to test.

Description

Returns true if an asset can be edited.

Version control systems like Perforce or Plastic SCM require that an asset be checked out before it can be edited. In such cases this task will test whether the asset is checked out and editable.

using System.Collections.Generic;
using UnityEditor;
using UnityEditor.VersionControl;
using UnityEngine;

public class EditorScript : MonoBehaviour { [MenuItem("Version Control/IsOpenForEdit")] public static void ExampleIsOpenForEdit() { AssetList assets = new AssetList(); assets.Add(Provider.GetAssetByPath("Assets/ExampleAsset.cs")); Debug.Log("ExampleAsset.cs is editable?" + Provider.IsOpenForEdit(assets[0])); } }

Some version control systems like Git support editing without checking out the asset, in this case the task will always return true.