> For the complete documentation index, see [llms.txt](https://zloma-scripts.gitbook.io/zloma-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zloma-scripts.gitbook.io/zloma-scripts/zloma_hud-free-escrow/api-reference/client-exports.md).

# Client Exports

## HUD

### `toggleHud`

Shows or hides the HUD.

```lua
exports["zloma_hud"]:toggleHud(true)
exports["zloma_hud"]:toggleHud(false)
```

***

## Stress

### `getStress`

Returns the local player's current stress.

```lua
local stress = exports["zloma_hud"]:getStress()
```

### `setStress`

Sets local player stress.

```lua
exports["zloma_hud"]:setStress(50)
```

### `addStress`

Adds stress to the local player.

```lua
exports["zloma_hud"]:addStress(10)
```

### `relieveStress`

Removes stress from the local player.

```lua
exports["zloma_hud"]:relieveStress(10)
```

***

## Stress Items

These exports are intended for `ox_inventory` usable item definitions. For `qb-inventory`, zloma\_hud registers usable items automatically through QBCore.

```lua
exports["zloma_hud"]:useStressTabletLight(data, slot)
exports["zloma_hud"]:useStressTabletMedium(data, slot)
exports["zloma_hud"]:useStressTabletHard(data, slot)

exports["zloma_hud"]:useStressTabletBoxLight(data, slot)
exports["zloma_hud"]:useStressTabletBoxMedium(data, slot)
exports["zloma_hud"]:useStressTabletBoxHard(data, slot)
```

***

## Mileage

### `getMileage`

Returns the current vehicle mileage from the client cache.

```lua
local mileage = exports["zloma_hud"]:getMileage()
```

### `getMileageByEntity`

Returns mileage for a specific vehicle entity.

```lua
local mileage = exports["zloma_hud"]:getMileageByEntity(vehicle)
```

### `getMileageByPlate`

Fetches mileage by plate through the server callback.

```lua
local mileage = exports["zloma_hud"]:getMileageByPlate("ABC123")
```

### `getMileageUnit`

Returns the configured mileage unit.

```lua
local unit = exports["zloma_hud"]:getMileageUnit()
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zloma-scripts.gitbook.io/zloma-scripts/zloma_hud-free-escrow/api-reference/client-exports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.