ui.text

Syntax

ui.text(font, x, y, string)

Parameters

font

Atlas font value, usually created with font.create or supplied by font.default.

x

Horizontal component or X coordinate for the requested operation.

y

Vertical component or Y coordinate for the requested operation.

string

Text string rendered by the UI operation.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Exact compatibility alias of ui.print. It draws replaceable text with the same shared ui-font ID, so a later ui.text or ui.print call replaces the previous printed text.

Examples

// Replace font, x, y, string with values described above.
ui.text(font, x, y, string);

Adapt the named values using the parameter details above. This reference pattern is intentionally read-only and is not offered as a downloadable runnable script; use a checked recipe when you need a complete script.