> For the complete documentation index, see [llms.txt](https://docs.17movement.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.17movement.net/complete-interface-system/api/hud-values.md).

# Hud Values

HUD values can be read and updated using:

```lua
local interface = exports['17mov_Interface']

local value = interface:getValue('key')
interface:setValue('key', value)
```

Most values are updated automatically by the script. You should only overwrite values that are controlled by your own resource.

When a value is empty, it is stored as `false`.

***

### Status

Values from `0` to `100`.

* `health`
* `armor`
* `hunger`
* `thirst`
* `stress`
* `oxygen`
* `stamina`
* `voice`

Example:

```lua
local hunger = interface:getValue('hunger')

interface:setValue('hunger', 75)
```

***

### Voice

* `talking` `boolean`
* `voiceMode` `number`
* `voiceModeMax` `number`
* `voiceRange` `string`

Example value:

```
2/3
```

***

### Player

* `serverId`
* `job`
* `jobGrade`
* `cash`
* `bank`
* `black`
* `societyMoney`
* `weapon`
* `ammoClip`
* `ammoTotal`
* `radio`

Money values are stored as formatted strings.

Example:

```lua
local job = interface:getValue('job')
local cash = interface:getValue('cash')
```

***

### World

* `street`
* `crossing`
* `zone`
* `heading`
* `compass`
* `time`

`compass` contains values such as:

```
N
NE
E
SE
S
SW
W
NW
```

`time` uses the following format:

```
HH:MM
```

***

### Vehicle

* `inVehicle` `boolean`
* `vehicleKind` `string`
* `speed` `number`
* `speedPercent` `number`
* `rpm` `number`
* `gear`
* `maxGear`
* `fuel`
* `engineHealth`
* `engineOn`
* `lights`
* `highBeams`
* `doorsLocked`
* `mileage`
* `seatbelt`

#### `vehicleKind`

Possible values:

```
land
air
water
```

#### `speed`

Raw vehicle speed.

#### `rpm`

Normalized RPM value from `0` to `100`.

#### `mileage`

Vehicle mileage in kilometers.

***

### Aircraft

* `altitude`
* `altitudeSea`
* `verticalSpeed`
* `airspeed`
* `pitch`
* `roll`
* `airHeading`
* `landingGear`
* `hasLandingGear`

`airspeed` is stored in knots.

***

### Boat

* `knots`
* `depth`
* `inWater`

***

### Info Panel

Custom info items use dynamic keys based on their ID.

```
info:<id>
info:<id>:sub
info:<id>:badge
```

For example, an info item with the ID `phone` uses:

```
info:phone
info:phone:sub
info:phone:badge
```

These values can also be updated using `setInfoItem`.