VersionControlObject

Description

The abstract base class for representing a version control system.

You can add support for a custom VCS by creating a new class derived from VersionControlObject and applying the VersionControlAttribute.

using UnityEditor.VersionControl;
using UnityEngine;

[VersionControl("Custom")]
public class CustomVersionControlObject : VersionControlObject
{
    public override void OnActivate()
    {
        Debug.Log("Custom VCS activated.");
    }

    public override void OnDeactivate()
    {
        Debug.Log("Custom VCS deactivated.");
    }
}

Using the example above, a new VCS option called Custom will show up in Version Control settings window. You should only perform VCS operations when a VersionControlObject is activated. OnActivate and OnDeactivate methods are called on your class to notify your code about the change.

Any persistent settings that must survive between Unity sessions (for example, the username or password) must be handled either by the underlying VCS, by using EditorUserSettings, or stored in a file. This is because the VersionControlObject is not serialized to disk and a new instance is created every time Unity starts up or when the VCS is activated.

The VersionControlObject is derived from ScriptableObject. This makes domain reloading handling simpler. You can add ScriptableObject.OnEnable method to restore the state if needed.

You can use AssetModificationProcessor and AssetPostprocessor.OnPostprocessAllAssets to get notifications from Unity when it wants to edit, add or remove assets.

Additional resources: VersionControlAttribute, VersionControlManager, EditorUserSettings, ScriptableObject, AssetModificationProcessor, AssetPostprocessor.

Properties

Public Methods

Inherited Members