Browse docsui.status

On this page

API method

`ui.status`

Draws or updates the persistent status label at the top-left of the video preview.

Syntax

Atlas Script

ui.status(text, ignored_color?, ignored_size?, ignored_id?)

Parameters

text: Text shown or updated by the UI operation. An empty status string removes the persistent status label.
ignored_color Optional: Compatibility color argument accepted by this status API but ignored by the current runtime.
ignored_size Optional: Compatibility size argument accepted by this status API but ignored by the current runtime.
ignored_id Optional: Compatibility identifier accepted by this status API but ignored by the current runtime.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Draws or updates the persistent status label at the top-left of the video preview. Pass an empty string to remove it. The registry accepts up to three additional compatibility arguments, but the current VM ignores them.

Examples

Draw text and a status message.atlas

font hud = font.create(1.4, rgb.lime);

event on_frame() {
    ui.print(hud, 0.05, 0.08, string.format("Frame {}", frame));
    ui.status(string.format("Runtime age {} ms", time_ms));
}

event on_stop() {
    ui.clear();
}