Exports

This page documents the public client exports and client events that other FiveM resources can use to interact with ARS Hud V3.

Client Exports

ToggleVisible

Show or hide the entire HUD.

exports['ars_hud']:ToggleVisible(state)

Parameter	Type	Description
`state`	`boolean`	`true` to show, `false` to hide

Example:

exports['ars_hud']:ToggleVisible(false)

Notify

Show a standard notification on the player’s HUD.

exports['ars_hud']:Notify(title, message, type, duration)

Parameter	Type	Required	Description
`title`	`string`	Yes	Notification title
`message`	`string`	Yes	Notification body text
`type`	`string`	No	Style: `'default'`, `'inform'`, `'error'`, `'success'`, `'warning'`
`duration`	`number`	No	Display duration in milliseconds

Example:

exports['ars_hud']:Notify('Bank', 'You deposited $500', 'success', 5000)

ShowAnnouncement

Show a server-wide announcement banner.

exports['ars_hud']:ShowAnnouncement(title, message, type, duration)

Parameter	Type	Required	Description
`title`	`string`	Yes	Announcement title
`message`	`string`	Yes	Announcement body text
`type`	`string`	No	Style: `'success'`, `'warning'`, `'error'`
`duration`	`number`	No	Display duration in milliseconds

Example:

exports['ars_hud']:ShowAnnouncement('Restart', 'Server restarting in 5 minutes', 'warning', 10000)

ShowSystemAlert

Show a system alert notification.

exports['ars_hud']:ShowSystemAlert(title, message, type, duration)

Parameter	Type	Required	Description
`title`	`string`	Yes	Alert title
`message`	`string`	Yes	Alert body text
`type`	`string`	No	Alert style type
`duration`	`number`	No	Display duration in milliseconds

Example:

exports['ars_hud']:ShowSystemAlert('Admin', 'An admin is spectating you', 'inform', 5000)

ShowEventNotification

Show an event notification with a countdown timer and optional image.

exports['ars_hud']:ShowEventNotification(title, message, timer, imageUrl)

Parameter	Type	Required	Description
`title`	`string`	Yes	Event title
`message`	`string`	Yes	Event description
`timer`	`number`	No	Countdown timer in seconds
`imageUrl`	`string`	No	URL for an event image

Example:

exports['ars_hud']:ShowEventNotification('Airdrop', 'Supply drop incoming!', 60, 'https://example.com/drop.png')

ShowActionNotification

Show a notification with accept and reject buttons. Waits for player response.

local accepted = exports['ars_hud']:ShowActionNotification(title, message, timeout)

Parameter	Type	Required	Description
`title`	`string`	Yes	Action title
`message`	`string`	Yes	Action description
`timeout`	`number`	No	Auto-dismiss timeout in milliseconds

Returns: boolean — true if accepted, false if rejected or timed out.

Example:

local accepted = exports['ars_hud']:ShowActionNotification('Trade', 'Accept the trade?', 15000)
if accepted then
    print('Player accepted the trade')
else
    print('Player rejected or timed out')
end

Clear Functions

Clear all active notifications of a specific type.

exports['ars_hud']:ClearAllNotifications()
exports['ars_hud']:ClearAllAnnouncements()
exports['ars_hud']:ClearAllSystemAlerts()
exports['ars_hud']:ClearAllEventNotifications()

Example:

exports['ars_hud']:ClearAllNotifications()

SetZoneInfo

Display a custom zone label with a color on the HUD. Useful for territory systems, safe zones, or area markers.

exports['ars_hud']:SetZoneInfo(zoneType, label, color)

Parameter	Type	Required	Description
`zoneType`	`string`	Yes	Zone type identifier
`label`	`string`	Yes	Zone label text
`color`	`string`	Yes	Color name or hex value

Example:

exports['ars_hud']:SetZoneInfo('gang', 'Ballas Territory', 'purple')

ClearZoneInfo

Remove the current zone label from the HUD.

exports['ars_hud']:ClearZoneInfo()

Example:

exports['ars_hud']:ClearZoneInfo()

SetSeatBeltState

Set the seatbelt state from an external script.

exports['ars_hud']:SetSeatBeltState(state)

Parameter	Type	Description
`state`	`boolean`	`true` for belt on, `false` for belt off

Example:

exports['ars_hud']:SetSeatBeltState(true)

Client Events

These events can be triggered from other client resources to control the HUD.

ars_hud:showNotification

Show a standard notification.

TriggerEvent('ars_hud:showNotification', title, message, type, duration)

ars_hud:showAnnouncement

Show an announcement.

TriggerEvent('ars_hud:showAnnouncement', title, message, type, duration)

ars_hud:showSystemAlert

Show a system alert.

TriggerEvent('ars_hud:showSystemAlert', title, message, type, duration)

ars_hud:showEventNotification

Show an event notification.

TriggerEvent('ars_hud:showEventNotification', title, message, timer, imageUrl)

ars_hud:Client:cinematiccamstart

Toggle cinematic mode from an external resource.

TriggerEvent('ars_hud:Client:cinematiccamstart')

Server Callbacks

ars_hud:server:isAdmin

Check if a player has admin permissions. Registered on the server, called from the client.

local isAdmin = lib.callback.await('ars_hud:server:isAdmin')

Returns: boolean

Example:

local isAdmin = lib.callback.await('ars_hud:server:isAdmin')
if isAdmin then
    print('Player is admin')
end

Note: This guide is written by a third party. If you find any incorrect or outdated information, please contact us on Discord so we can update it for you.