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.
CloseFor 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.
CloseTests whether the VersionControlObject is connected to an underlying version control system.
There are various reasons why your VersionControlObject may not be connected. For example:
In all these cases this property will return false.
using UnityEditor; using UnityEditor.VersionControl; using UnityEngine;
[VersionControl("Custom")] public class CustomVersionControlObject : VersionControlObject, ISettingsInspectorExtension { bool m_Active; bool m_IsConnected;
public override bool isConnected => m_IsConnected;
public void OnEnable() { // m_Active will be false if CustomVersionControlObject has just been activated. // It will be true if OnEnable was called after domain reload. In that case we want to reestablish connection. if (m_Active) Connect(); }
public void OnDisable() { // Let's assume that domain reload kills connection to underlying VCS. Disconnect(); }
public override void OnActivate() { m_Active = true; // Let's try to automatically establish connection to underlying VCS. // It will not work the first time CustomVersionControlObject is activated because username is not configured yet. // However it will work on subsequent Unity startup. Connect(); }
public override void OnDeactivate() { m_Active = false; Disconnect(); }
public void OnInspectorGUI() { var oldUsername = EditorUserSettings.GetConfigValue("vcCustomUsername"); var newUsername = EditorGUILayout.TextField("Username (hint: TestUser):", oldUsername); if (newUsername != oldUsername) EditorUserSettings.SetConfigValue("vcCustomUsername", newUsername);
EditorGUILayout.LabelField("Connected:", m_IsConnected ? "Yes" : "No");
if (GUILayout.Button("Connect")) Connect(); }
void Connect() { var username = EditorUserSettings.GetConfigValue("vcCustomUsername"); m_IsConnected = username == "TestUser"; }
void Disconnect() { m_IsConnected = false; } }
Additional resources: VersionControlObject, ISettingsInspectorExtension.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.