Logo

DIVERSITY

Documentation

Modules

TextUI

The TextUI module provides functions for displaying and hiding help text messages on the player's screen. It supports various text UI systems.

Client Functions


GetResourceName

Returns the name of the underlying textui resource being used.

client.lua
local resourceName = dBridge.TextUI.GetResourceName()
Returned DataTypeDescription
resourceName
string
The name of the textui resource (e.g., "ox_lib").

Show

Displays a text UI (help text) on the screen.

This function depends on the core framework's Text UI system. If your framework does not provide a built-in Text UI function (e.g., some standalone or custom setups), you must ensure one is configured in the bridge.

client.lua
dBridge.TextUI.Show('Press [E] to interact')
ArgumentTypeDescription
text
string
Text to display.

Hide

Hide the currently active TextUI.

client.lua
dBridge.TextUI.Hide()

Was this page helpful?