Skip to content
Version 2.32.0
↓ Get the launcher

IWindowControl interface

Handle to a registered interactive uGUI window. Auto-removed on plugin/framework dispose.

public interface IWindowControl
name description
IsShown { get; } True while the window is visible AND currently mounted in the scene.
Rect { get; } Current on-screen rect (position + size). default until the window is mounted.
BringToFront() Put this window on top, exactly as if it had just been opened: any window opened or brought to the front LATER goes above it again (not sticky). A HUD window is also lifted above Tools/Debug windows until it is next hidden. Never raises a window above Topmost windows or a higher ZOrder. A Tools/Debug window shown from hidden is already put on top automatically, so this is needed mainly for an ALREADY VISIBLE window (e.g. re-opening an open child from its parent) or a HUD window. Safe on a not-yet-mounted window (applied when it mounts).
MarkDirty() Hints to the framework to re-poll and apply this window’s element values immediately rather than waiting for the next scheduled refresh.
Remove() Permanently remove the window from the scene and the window registry.
SetRect(…) Move/resize the window (size honoured only for Resizable windows). The new rect is persisted by the framework. Used by plugins that remember their own per-mode geometry.
SetVisible(…) Show or hide the window for this session only. Does NOT persist — the choice is lost on relaunch. For a user-facing toggle whose state should survive a restart, use SetVisiblePersist.
SetVisiblePersist(…) Show or hide the window AND persist the choice to the active layout slot (per resolution), so it is restored on the next relaunch. This is the single source of truth the framework reapplies on launch — the layout-editor eye-toggle writes the same slot. Use it for user-driven visibility toggles (hotkeys, close buttons) instead of SetVisible plus a private config key, which desyncs from the slot and loses to it on relaunch.