# XWUIGameVehicleHUD

Vehicle overlay HUD with dashboard-style gauges. It reads out `speed`/`maxSpeed`, `fuel`/`maxFuel`, `damage` (0-100%), `gear`, and `rpm` as on-screen instruments. The `conf_comp.layout` preset adapts the gauge arrangement for `car`, `aircraft`, or `boat`, and `showMinimap` adds a minimap placeholder. Stream live telemetry with `updateData({ speed, fuel, damage, gear, rpm, ... })`.

## Basic Usage

Mounts the vehicle HUD with its car-layout dashboard gauges.

```example
file: examples/BasicUsage.ts
html: examples/BasicUsage.html
title: Basic Usage
description: Mounts the vehicle HUD showing speed, fuel, damage, gear, and RPM gauges in the car layout.
```

## Aircraft Layout

Switches to the aircraft layout preset with high airspeed and the minimap enabled.

```example
file: examples/AircraftLayout.ts
html: examples/AircraftLayout.html
title: Aircraft Layout
description: The HUD in aircraft layout with a climb gear, high airspeed, and showMinimap turned on.
```

## Critical State

Drives fuel near empty and damage high so the fuel and damage gauges read alarm levels.

```example
file: examples/CriticalState.ts
html: examples/CriticalState.html
title: Critical State
description: A car HUD with fuel at 6% and damage at 82%, showing the near-empty and heavily-damaged gauge states.
```

```api
```