Loading content...
Text UI
A short text bubble anchored to a screen edge, with an optional 3D keycap and icon.
A short text bubble anchored to a screen edge, with an optional 3D keycap and icon.
lib.showTextUI shows a short prompt anchored to a screen edge, with an optional keycap and
Lucide icon. Pair it with lib.hideTextUI().
lib.showTextUI('Press to interact', { key = 'E' })
lib.showTextUI('Enter the shop', {
key = 38, -- a control id, resolved to a key name
icon = 'door-open',
position = 'bottom-center',
})
lib.hideTextUI()lib.showTextUI(content, options?) and lib.hideTextUI(position?)
contentstringrequiredThe text to show.
options.keystring | numberoptionalA literal key ('E') or a control id (number, resolved via lib.keys.getName).
options.iconstringoptionalA Lucide icon name (e.g. door-open).
options.positionstringoptionaltop-center, right-center (default), bottom-center, left-center.
lib.hideTextUI(position?) hides one position, or all of them when omitted.
No auto-hide — pair show with hide on zone enter / exit. You can have one bubble per position at once. For three or more keys, use key hints instead.