Get Player Ui

A pirate steps into the sunlit Crystal Grotto, and instantly, a custom gem-tracking HUD snaps onto their screen.

To draw custom UI, you first need to grab the player's personal screen space using GetPlayerUI, which is a failable call that might not exist yet.

We loop through our players, safely unwrap their UI with the failable bracket syntax, and then call AddWidget to attach our custom canvas.

Reach for GetPlayerUI whenever you need to push custom menus, health bars, or scoreboards directly to a specific player's screen.

ui_demo := class(creative_device):
    @editable
    MyCanvas : canvas = canvas{}
    OnBegin<override>()<suspends>:void =
        for (Player : GetPlayspace().GetPlayers()):
            if (UI := GetPlayerUI[Player]):
                UI.AddWidget(MyCanvas)