esx_textui

esx_textui shows one persistent prompt on the screen, typically an interaction hint such as "Press [E] to open the shop". Unlike a notification it stays until you hide it. Call ESX.TextUI when the player enters an interaction area and ESX.HideUI when they leave.

OverviewCopy Anchor Link

Only one TextUI is visible at a time. Showing a new one replaces the current one.

FunctionsCopy Anchor Link

ESX.TextUICopy Anchor Link

ESX.TextUI(message, type)

ESX.HideUICopy Anchor Link

Hides the current TextUI. Does nothing when none is shown.

ESX.HideUI()

Example: interaction pointCopy Anchor Link

local shopCoords = vector3(25.7, -1347.3, 29.49)
local isShowing = false

CreateThread(function()
    while true do
        local sleep = 500
        local distance = #(GetEntityCoords(PlayerPedId()) - shopCoords)

        if distance < 2.0 then
            sleep = 0
            if not isShowing then
                ESX.TextUI("Press ~g~[E]~s~ to open the shop", "info")
                isShowing = true
            end

            if IsControlJustReleased(0, 38) then -- 38 = E
                TriggerEvent("my_shop:open")
            end
        elseif isShowing then
            ESX.HideUI()
            isShowing = false
        end

        Wait(sleep)
    end
end)

For many points, use the point helpers from esx_lib instead of a distance loop.

ExportsCopy Anchor Link

EventsCopy Anchor Link

Both are registered with ESX.SecureNetEvent, so they are meant to be triggered from the server:

TriggerClientEvent("ESX:TextUI", playerId, "You are in a ~r~restricted~s~ zone", "error")
TriggerClientEvent("ESX:HideUI", playerId)

Color codesCopy Anchor Link

~r~ red, ~b~ blue, ~g~ green, ~y~ yellow, ~p~ purple, ~c~ grey, ~m~ dark grey, ~u~ black, ~o~ orange. Close a color with ~s~.

Debug commandsCopy Anchor Link

With Config.EnableDebug = true in es_extended, the commands /textui:error, /textui:success, /textui:info and /textui:hide are registered for testing.

Common issuesCopy Anchor Link

• Prompt flickers. You call ESX.TextUI every frame. Use a flag such as isShowing and only call it on state changes.
• Prompt never disappears. The script that showed it was restarted or never reached the ESX.HideUI branch. Hide it in an onResourceStop handler.
• Nothing appears with type "warning". esx_textui has no warning style. The NUI script fails on unknown types; use "error" instead.

RelatedCopy Anchor Link

• Core resources overview
• Client functions
• esx_notify
• Point helper

Frequently asked questions