Logging Widget Trees

Summary

Published: Mar 31 2024 by mana vortex Last documented update: Apr 15 2024 by mana vortex

This page will tell you how to log widget trees and layer trees.

Wait, that's not what I want!

To learn more about logging, check Logging

Logging layer trees

You can find a list of existing UI layers on UI Scripting -> InkSystemLayers.

To traverse a layer's children, you first need to get the corresponding layer's virtual window:

private static func PrintLayerHierarchy(layerName: CName) {
    let window = GameInstance.GetInkSystem().GetLayer(layerName).GetVirtualWindow();
    let rootWidget = window.GetWidgetByPathName(n"Root") as inkCanvas;
    // The function LogWidgetTree is defined below
    LogWidgetTree(n"DEBUG", rootWidget);
}

PrintLayerHierarchy(n"inkHUDLayer")

Logging Widget Trees

Big thanks to Rayshader for walking me through this with the patience of a saint!

You can add this code to your logs.reds file:

public static func LogWidgetTree(channel: CName, widget: wref<inkCompoundWidget>, opt props: Bool, opt indent: String) {
    let i = 0;

    if StrLen(indent) == 0 {
      LogChannel(channel, s"\(widget.GetName()) - \(widget.GetClassName())");
    }
    while i < widget.GetNumChildren() {
      let child: wref<inkWidget> = widget.GetWidget(i);
      let compChild = child as inkCompoundWidget;

      LogChannel(channel, s"\(indent)|-- \(child.GetName()) - \(child.GetClassName())");
      if props {
        let anchor = child.GetAnchor();
        let size = child.GetSize();
        let scale = child.GetScale();

        LogChannel(channel, s"\(indent){");
        LogChannel(channel, s"\(indent)  anchor: inkEAnchor.\(anchor)");
        LogChannel(channel, s"\(indent)  size: (\(size.X), \(size.Y))");
        LogChannel(channel, s"\(indent)  scale: (\(scale.X), \(scale.Y))");
        let wText = child as inkText;

        if IsDefined(wText) {
          LogChannel(channel, s"\(indent)  text: \"\(wText.GetText())\"");
          LogChannel(channel, s"\(indent)  fontSize: \"\(wText.GetFontSize())\"");
        }
        LogChannel(channel, s"\(indent)}");
      }
      if IsDefined(compChild) {
        LogWidgetTree(channel, compChild, props, s"\(indent)    ");
      }
      i += 1;
    }
  }