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.
CloseSets a custom IPanelChangeReceiver in the panelChangeReceiver setter to receive every change event. This method is available only in development builds and the editor, as it is a debug feature to go along the profiling of an application.
Note that the values returned may change over time when the underlying architecture is modified.
As this is called at every change marked on any visual element of the panel, the overhead is not negligible.
The callback will not be called in release builds as the method is stripped.
The following example uses the panelChangeReceiver in a game.
To test it, add the component to a GameObject and the Panel Setting asset linked in the component fields.
using System; using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.UIElements; public class ChangeLogger : MonoBehaviour, IDebugPanelChangeReceiver { public PanelSettings panelSettings; public bool logChanges = true; public bool printOnConsole = false; public bool includeStacktrace = true; public List<ChangeEntry> changes; private void OnEnable() { panelSettings.SetPanelChangeReceiver(this); } public void Initialize() { changes.Clear(); } public void OnVisualElementChange(VisualElement element, VersionChangeType changeType) { if (logChanges) { if (changes == null) changes = new List<ChangeEntry>(); changes.Add(new ChangeEntry() { changeType = changeType, element = element.ToString(), stackTrace = includeStacktrace ? Environment.StackTrace : null }); } if (printOnConsole) { Debug.Log($"{string.Join(",", changeType.toStrings()),-40} {element}"); } } [Serializable] public struct ChangeEntry { public string element; public VersionChangeType changeType; [TextArea(10, 30)] public string stackTrace; } } public static class ChangeTypeHelpers { public static List<string> toStrings(this VersionChangeType type) { var changes = new List<string>(); foreach (var value in (VersionChangeType[])Enum.GetValues(typeof(VersionChangeType))) { if ((type & value) != 0) changes.Add(value.ToString()); } return changes; } }
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.