Client

showTextUI

fjsf.showTextUI(text, data)

Displays a TextUI element on the screen.

TextUI is typically used for interaction hints, short prompts, or contextual information.

---

Parameters

• text string Main text displayed in the TextUI.

• data table | nil Optional TextUI configuration object.

  Supported fields:

  • description string | nil Secondary text displayed below the main text.

  • icon string | nil FontAwesome icon class.

  • iconAnim string | nil Optional icon animation class.

  • color string | nil Text color (CSS value).

  • background string | nil Background color (CSS value).

  • size string | nil TextUI size.

    Allowed values:

    • small

    • medium

    • large

  • position string | nil Screen position.

    Supported values:

    • right-up

    • right-middle

    • right-down

    • center-up

    • center-middle

    • center-down

    • left-up

    • left-middle

    • left-down

  • sounds boolean | nil Enables sound effect when the TextUI appears.

---

iconAnim

Optional animation applied to the TextUI icon.

Type: string | nil

Allowed values are identical to notify / alert icon animations. Invalid values are ignored.

---

Returns

This function does not return anything.

---

Example

fjsf.showTextUI('[E] Open Door', {
    description = 'Press to interact',
    icon = 'fa-solid fa-door-open',
    iconAnim = 'pulse',
    position = 'right-middle',
    size = 'medium'
})

---

hideTextUI

fjsf.hideTextUI()

Hides the currently active TextUI.

---

Returns

This function does not return anything.

---

Example

fjsf.hideTextUI()

---

isTextUIActive

fjsf.isTextUIActive()

Returns whether a TextUI is currently visible.

---

Returns

• boolean

  • true – TextUI is visible

  • false – No active TextUI

---

Example

if fjsf.isTextUIActive() then
    print('TextUI is visible')
end