EXPORTS & API

Exports

1. Notifications

Display a stylish notification with optional custom screen positioning and icons!

Syntax:

-- types: 'success', 'error', 'info'
-- position (optional): 'top-right', 'top-left', 'bottom-right', 'bottom-left', 'center-right', 'center-left', 'top', 'bottom'
-- icon (optional): 'Check', 'Star', 'Bell', 'Heart', 'Zap', 'Shield', 'Alert', 'X', 'Info'
exports.hyperscripts_ui:Notify('success', 'Vehicle Locked', 'Your T20 has been locked', 'top-right', 'Shield')

2. Text UI

Show a sleek minimalist 3D Text UI replacement prompt.

Syntax:

-- Show (with optional forced positioning)
exports.hyperscripts_ui:TextUI(true, 'Open Vault', 'ALT', 'right-center')

-- Hide
exports.hyperscripts_ui:TextUI(false)

3. Progress Bars

Display a sleek, beautifully animated on-screen progress bar with optional circular and linear variants.

Syntax:

-- Start a progress bar
-- type (optional): 'linear' or 'circular'. Defaults to 'linear'.
exports.hyperscripts_ui:Progress(label, duration_ms, type)

-- Cancel an active progress bar
exports.hyperscripts_ui:CancelProgress()

Example Usage:

-- Linear bar lasting 5 seconds
exports.hyperscripts_ui:Progress('Lockpicking Door', 5000, 'linear')

-- Circular hacking bar lasting 8 seconds
exports.hyperscripts_ui:Progress('Hacking ATM', 8000, 'circular')

-- Oh no, cops arrived! Cancel it early:
Wait(2000)
exports.hyperscripts_ui:CancelProgress()

4. Set Theme

Change the UI theme dynamically.

-- themes: 'zenith', 'midnight', 'forest', 'crimson'
exports.hyperscripts_ui:SetTheme('crimson')

Commands

• /hyperscripts_ui: Toggles the main UI (Settings/Chat) for testing.

Edit Mode

To reposition elements:

1

Step 1

Open the menu (/hyperscripts_ui).

2

Step 2

Click Edit Layout.

3

Step 3

Drag the Chat, Notification Area, or Text UI to your desired position.

4

Step 4

Press Escape to save and exit.