> For the complete documentation index, see [llms.txt](https://docs.justscripts.net/scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.justscripts.net/scripts/justhud/exports.md).

# Exports

## Client-side Exports

### ToggleHud

Hide or show the HUD

```lua
-- toggle: boolean
exports.Justhud:ToggleHud(toggle)
```

### Notify

Send a notification to player hud

```lua
-- title: string
-- content: string
-- type: string - success,warning,error,info,question
-- time: number - showing time in ms
exports.Justhud:Notify(title,content,type)
```

### AddProgress

Shows progress bar on user hud. see [here ](/scripts/justhud/elements.md#icons)for icon docs.

```lua
-- text: string - Progress bar description
-- icon: string - Progress bar icon
-- time: number - Progress bar showing time in ms
-- options: tabel - extra objects
exports.JustHud:AddProgress(text,icon,time, options)

exports.JustHud:AddProgress("Eating","internal:BurgerIcon", 5000, {
    freeze = true, -- freeze player during the progress
    onFinish = function ()
    end
})
```

### ClearProgress

Stops the currently running progress

```lua
exports.JustHud:ClearProgress()
```

### GetSeatbeltStatus

Determining whether player has seatbelt on

```lua
-- return: boolean
exports.JustHud:GetSeatbeltStatus()
```

### SetSeatbeltStatus

Changing player seatbelt status

```lua
-- toggle: boolean
exports.JustHud:SetSeatbeltStatus(toggle)
```

### IsSpeedLimited

Determining whether player vehicle speed is limited

```lua
-- return: boolean
exports.JustHud:IsSpeedLimited()
```

### GetSettingValue

Get the value of custom settings (Config.Settings.Options.custom)

```lua
-- id: string - setting id
-- return: mixed
exports.JustHud:GetSettingValue(id)
```

### GetColor

Get the color changed in settings (default if unchanged)

```lua
-- id: string - color id (primary,secondary,success,danger,warning,info)
-- return: string
exports.JustHud:GetColor(id)
```

### AddBroadcast

Sends a broadcast to chat for all players

```lua
-- title: string
-- icon: string
-- content: string
-- color: string (color ID or hexcolor)
exports.JustHud:AddBroadcast(title, icon, content, color)
```