Skip to main content

TextUI

The TextUI module displays a small help text with a key hint in the NUI. There are two ways to show it: Show keeps it visible until Hide is called, while ShowThread automatically hides it shortly after it stops being called — making it ideal to call repeatedly inside a loop. The default color is taken from Config.TextUIColor (#00e676, MSK green).

MSK.TextUI.Show​

Show the TextUI and keep it visible until it is hidden.

Parameters
key - string - The key that needs to be pressed (defaults to E)
text - string - Text
color - string - Color as hex - Optional, defaults to Config.TextUIColor

MSK.TextUI.Show(key, text, color)

-- Example 1: default color
MSK.TextUI.Show('E', 'Press ~g~E~s~ to interact')

-- Example 2: specific color
MSK.TextUI.Show('E', 'Press ~g~E~s~ to interact', '#5eb131')

-- As an Export:
exports.msk_core:ShowTextUI(key, text, color)

MSK.TextUI.ShowThread​

Show the TextUI and automatically hide it shortly after it stops being called. Designed to be called repeatedly (e.g. every frame) while the player is in range.

Parameters
key - string - The key that needs to be pressed (defaults to E)
text - string - Text
color - string - Color as hex - Optional, defaults to Config.TextUIColor

MSK.TextUI.ShowThread(key, text, color)

-- Example
CreateThread(function()
    while true do
        local sleep = 250
        local distance = #(MSK.Player.coords - vector3(572.04, 2724.34, 42.05))

        if distance <= 2.5 then
            sleep = 0
            MSK.TextUI.ShowThread('E', 'Press ~g~E~s~ to interact')
        end

        Wait(sleep)
    end
end)

-- As an Export:
exports.msk_core:ShowTextUIThread(key, text, color)

MSK.TextUI.Hide​

Hide the TextUI.

MSK.TextUI.Hide()

-- As an Export:
exports.msk_core:HideTextUI()

MSK.TextUI.Active​

Check if the TextUI is currently shown.

Returns
isActive - boolean - Whether the TextUI is active

local isActive = MSK.TextUI.Active()

-- As an Export:
local isActive = exports.msk_core:TextUIActive()