Text UI
Display persistent text UI elements on the screen, typically used for interaction prompts.
Exports
| Export | Parameters | Returns |
|---|---|---|
ShowTextUI | (text, options) | — |
HideTextUI | () | — |
IsTextUIOpen | () | boolean |
ShowTextUI Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
text | string | Yes | Text to display — keybind is parsed from [E] brackets |
Options
| Field | Type | Description |
|---|---|---|
icon | string | FontAwesome icon name or image URL |
iconColor | string | Custom icon color (hex or CSS color) |
iconAnimation | string | Icon animation: 'spin', 'beat', 'fade', 'bounce', 'shake', 'beatFade', 'spinPulse' |
position | string | 'right-center', 'left-center', 'top-center', 'bottom-center' |
label | string | Custom label text above the main text |
style | table | Custom CSS styles |
Usage
Basic Text UI
exports['flux-ui-pack']:ShowTextUI('Press [E] to interact')With Icon
exports['flux-ui-pack']:ShowTextUI('Press [E] to open', {
icon = 'door-open',
iconColor = '#e74c3c',
iconAnimation = 'beat'
})Custom Position
exports['flux-ui-pack']:ShowTextUI('Press [G] to pick up', {
icon = 'hand',
position = 'top-center'
})Hide Text UI
exports['flux-ui-pack']:HideTextUI()Check if Open
local isOpen = exports['flux-ui-pack']:IsTextUIOpen()
if isOpen then
print('Text UI is currently visible')
endLast updated on