Version: 2021.3
LanguageEnglish
  • C#

VersionControlObject.Refresh

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 void Refresh();

Description

Called when the cached state should be discarded and the new state should be retrieved from the underlying VCS.

Unity calls this method when it regains application focus. The user might have made some changes to the state of version-controlled files outside of Unity and so your VersionControlObject should retrieve the updated state. Do not overwrite this method if there's no cached state to update.

using UnityEditor.VersionControl;
using UnityEngine;

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

Additional resources: VersionControlObject.