Client

Client-side exports for ak47_hud.

ToggleHudElement

Dynamically shows or hides a specific HUD element or all HUD elements.

exports['ak47_hud']:ToggleHudElement(element, state)

Parameter	Type	Required	Description
`element`	string	Yes	Element ID (`money`, `status`, `compass`, `location`, `vehicle`, `crosshair`, `party`, `killfeed`, `chat`, `notification`, `serverinfo`, `minimap`, `all`)
`state`	boolean	Yes	`true` to show, `false` to hide

Returns: void

GetHudState

Returns the current visibility state of a specified HUD element.

local isVisible = exports['ak47_hud']:GetHudState(element)

Parameter	Type	Required	Description
`element`	string	Yes	HUD element ID or `cinematic`

Returns: boolean

SetCinematicMode

Enables or disables black cinematic letterbox bars.

exports['ak47_hud']:SetCinematicMode(state)

Parameter	Type	Required	Description
`state`	boolean	Yes	`true` to enable cinematic bars, `false` to disable

Returns: void

Notify

Triggers a custom HUD notification message.

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

Parameter	Type	Required	Description
`message`	string	Yes	Text content of the notification
`type`	string	No	Type: `default`, `info`, `success`, `warning`, `error`
`duration`	number	No	Display duration in milliseconds (default: 5000)
`title`	string	No	Optional notification header title

Returns: void

ToggleSeatbeltSystem

Enables or disables the client-side seatbelt and crash ejection physics system.

exports['ak47_hud']:ToggleSeatbeltSystem(state)

Parameter	Type	Required	Description
`state`	boolean	Yes	`true` to enable, `false` to disable

Returns: void

SetSeatbelt

Sets the local player seatbelt buckled state.

exports['ak47_hud']:SetSeatbelt(state)

Parameter	Type	Required	Description
`state`	boolean	Yes	`true` to buckle up, `false` to unbuckle

Returns: void

HasSeatbeltOn

Returns whether the local player is currently buckled in.

local isBuckled = exports['ak47_hud']:HasSeatbeltOn()

Parameter	Type	Required	Description
None	N/A	No	Takes no parameters

Returns: boolean

GetSeatbeltSystemState

Returns whether the seatbelt physics system is currently active.

local isSystemActive = exports['ak47_hud']:GetSeatbeltSystemState()

Parameter	Type	Required	Description
None	N/A	No	Takes no parameters

Returns: boolean

AddToSeatbeltWhitelist

Adds a vehicle class or vehicle model to the seatbelt exemption whitelist.

exports['ak47_hud']:AddToSeatbeltWhitelist(whitelistType, value)

Parameter	Type	Required	Description
`whitelistType`	string	Yes	Whitelist category: `class` or `model`
`value`	string \| number	Yes	Class index integer or vehicle model name string

Returns: void

RemoveFromSeatbeltWhitelist

Removes a vehicle class or model from the seatbelt exemption whitelist.

exports['ak47_hud']:RemoveFromSeatbeltWhitelist(whitelistType, value)

Parameter	Type	Required	Description
`whitelistType`	string	Yes	Whitelist category: `class` or `model`
`value`	string \| number	Yes	Class index integer or vehicle model name string

Returns: void

ToggleStressSystem

Enables or disables individual stress subsystems or all stress tracking.

exports['ak47_hud']:ToggleStressSystem(system, state)

Parameter	Type	Required	Description
`system`	string	Yes	Target system: `vehicle`, `shooting`, `melee`, `effects`, or `all`
`state`	boolean	Yes	`true` to enable, `false` to disable

Returns: void

GetStressSystemState

Returns the active state of a specific stress subsystem.

local isActive = exports['ak47_hud']:GetStressSystemState(system)

Parameter	Type	Required	Description
`system`	string	Yes	Target subsystem: `vehicle`, `shooting`, `melee`, or `effects`

Returns: boolean

AddToStressBypass

Adds a job, vehicle model, vehicle class, or weapon to the stress exemption list.

exports['ak47_hud']:AddToStressBypass(bypassType, value)

Parameter	Type	Required	Description
`bypassType`	string	Yes	Bypass category: `job`, `vehicle`, `class`, or `weapon`
`value`	string \| number	Yes	Identifier string or class integer

Returns: void

RemoveFromStressBypass

Removes an identifier from the stress exemption bypass list.

exports['ak47_hud']:RemoveFromStressBypass(bypassType, value)

Parameter	Type	Required	Description
`bypassType`	string	Yes	Bypass category: `job`, `vehicle`, `class`, or `weapon`
`value`	string \| number	Yes	Identifier string or class integer

Returns: void

OpenRadarUI

Opens the police radar remote control menu.

exports['ak47_hud']:OpenRadarUI()

Parameter	Type	Required	Description
None	N/A	No	Takes no parameters

Returns: void

SetRadarPower

Toggles police radar power on or off.

exports['ak47_hud']:SetRadarPower(state)

Parameter	Type	Required	Description
`state`	boolean	Yes	`true` to power on, `false` to power off

Returns: void

GetRadarData

Returns live speed and license plate data captured by the police radar.

local data = exports['ak47_hud']:GetRadarData()

Parameter	Type	Required	Description
None	N/A	No	Takes no parameters

Returns: table - { patrolSpeed = number, front = table, rear = table }

SetRadarLock

Locks or unlocks target speed on a specific radar antenna.

exports['ak47_hud']:SetRadarLock(direction, state)

Parameter	Type	Required	Description
`direction`	string	Yes	Antenna direction: `front` or `rear`
`state`	boolean	Yes	`true` to lock speed, `false` to unlock

Returns: void

ClearRadarFast

Clears saved fastest speed memory on specified radar antennas.

exports['ak47_hud']:ClearRadarFast(direction)

Parameter	Type	Required	Description
`direction`	string	Yes	Target antennas: `front`, `rear`, or `all`

Returns: void

GetRadarState

Returns current power status and settings of the police radar.

local radarInfo = exports['ak47_hud']:GetRadarState()

Parameter	Type	Required	Description
None	N/A	No	Takes no parameters

Returns: table - { power = boolean, settings = table }

Server