VersionControlObject
class in
UnityEditor.VersionControl
/
Inherits from:ScriptableObject
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
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 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.
See Also: VersionControlAttribute, VersionControlManager, EditorUserSettings, ScriptableObject, AssetModificationProcessor, AssetPostprocessor.
Properties
isConnected | Tests whether the VersionControlObject is connected to an underlying version control system. |
Public Methods
GetExtension | Gets optional extension object. |
OnActivate | Called when your version control system is activated. |
OnDeactivate | Called when your version control system is deactivated. |
Refresh | Called when the cached state should be discarded and the new state should be retrieved from the underlying VCS. |
Inherited Members
Properties
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
Operators
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
Messages
Awake | This function is called when the ScriptableObject script is started. |
OnDestroy | This function is called when the scriptable object will be destroyed. |
OnDisable | This function is called when the scriptable object goes out of scope. |
OnEnable | This function is called when the object is loaded. |
OnValidate | Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. |
Reset | Reset to default values. |