# CyberM.vehicles — server runtime

Runs on the dedicated server and is authoritative: state written here is the truth every client is told about.

43 functions.

## all

```lua
CyberM.vehicles.all([bucket])
```

`NETWORK` — Uses the network backend.

Lists authoritative server vehicles.

Returns snapshots ordered by CyberM ID. An optional routing bucket filters the result; omitting it returns every vehicle visible to the resource.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `bucket` | `integer` | optional | — |

Returns: `array of vehicle tables`

Registered in `LuaResourceRuntime.cs` (line 2769) as `LuaResourceRuntime.Bootstrap`.

## breakAllGlass

```lua
CyberM.vehicles.breakAllGlass(id, [count])
```

`NETWORK` — Uses the network backend.

Breaks a range of vehicle glass elements.

Requires `world.vehicles`. Breaks the first `count` destructible-glass bits. The optional count defaults to all 32 and must be in 0..32.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `count` | `integer` | optional | `32` |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2712) as `LuaResourceRuntime.Bootstrap`.

## breakGlass

```lua
CyberM.vehicles.breakGlass(id, glass)
```

`NETWORK` — Uses the network backend.

Breaks one vehicle glass element.

Requires `world.vehicles`. Convenience wrapper over `setGlassBroken(id, glass, true)`; the canonical bit is replicated and retained for late joiners.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `glass` | `integer|string` | required | — |

Returns: `boolean success`

```lua
CyberM.vehicles.breakGlass(vehicleId, 0)
```

Registered in `LuaResourceRuntime.cs` (line 2710) as `LuaResourceRuntime.Bootstrap`.

## breakLight

```lua
CyberM.vehicles.breakLight(id, index)
```

`NETWORK` — Uses the network backend.

Breaks one vehicle light.

Requires `world.vehicles`. Convenience wrapper over `setLightBroken(id, index, true)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2719) as `LuaResourceRuntime.Bootstrap`.

## breakTire

```lua
CyberM.vehicles.breakTire(id, index)
```

`NETWORK` — Uses the network backend.

Breaks one vehicle tire.

Requires `world.vehicles`. Convenience wrapper over `setTireBroken(id, index, true)`. Tire indexes are 0..3.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |

Returns: `boolean success`

```lua
CyberM.vehicles.breakTire(vehicleId, 0)
```

Registered in `LuaResourceRuntime.cs` (line 2724) as `LuaResourceRuntime.Bootstrap`.

## closeDoor

```lua
CyberM.vehicles.closeDoor(id, door)
```

`NETWORK` — Uses the network backend.

Closes a door, trunk, or hood.

Requires `world.vehicles`. Convenience wrapper over `setDoorOpen(id, door, false)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `door` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2737) as `LuaResourceRuntime.Bootstrap`.

## closeWindow

```lua
CyberM.vehicles.closeWindow(id, window)
```

`NETWORK` — Uses the network backend.

Closes one side window.

Requires `world.vehicles`. Convenience wrapper over `setWindowOpen(id, window, false)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `window` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2747) as `LuaResourceRuntime.Bootstrap`.

## create

```lua
CyberM.vehicles.create(definition)
```

`NETWORK` — Uses the network backend.

Creates a server-owned network vehicle.

Requires `world.vehicles`. The definition selects the record, transform, routing bucket, appearance, colors, flags, health, and optional initial damage. The server allocates the CyberM ID and replicates the canonical vehicle to interested clients.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `definition` | `table` | required | — |

Returns: `vehicle ID, or `nil, reason``

```lua
local id, reason = CyberM.vehicles.create({
  record = "Vehicle.v_standard2_thorton_galena_player",
  position = { x = -1671.2, y = -710.3, z = 49.9 },
  yaw = 90.0,
})
```

Registered in `LuaResourceRuntime.cs` (line 2677) as `LuaResourceRuntime.Bootstrap`.

## damageBodyCell

```lua
CyberM.vehicles.damageBodyCell(id, cell, amount)
```

`NETWORK` — Uses the network backend.

Adds damage to one body cell.

Requires `world.vehicles`. Adds the amount to the current normalized cell and clamps the result to 0..1.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `cell` | `integer` | required | — |
| `amount` | `number` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2697) as `LuaResourceRuntime.Bootstrap`.

## damageBodyZone

```lua
CyberM.vehicles.damageBodyZone(id, zone, amount)
```

`NETWORK` — Uses the network backend.

Adds damage across a body zone.

Requires `world.vehicles`. Adds the amount to each selected body cell and clamps every result to 0..1.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `zone` | `string|table` | required | — |
| `amount` | `number` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2703) as `LuaResourceRuntime.Bootstrap`.

## get

```lua
CyberM.vehicles.get(id)
```

`NETWORK` — Uses the network backend.

Returns one authoritative server vehicle snapshot.

Reads canonical identity, transform, flags, colors, damage, openings, occupants, and authority state. Returns `nil` for an unknown ID.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `vehicle table, or `nil``

Registered in `LuaResourceRuntime.cs` (line 2768) as `LuaResourceRuntime.Bootstrap`.

## getDamage

```lua
CyberM.vehicles.getDamage(id)
```

`NETWORK` — Uses the network backend.

Returns the canonical damage snapshot.

Reads the server-owned body grid and broken glass, light, and tire masks. It returns `nil` when the vehicle ID is unknown.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `damage table, or `nil``

Registered in `LuaResourceRuntime.cs` (line 2693) as `LuaResourceRuntime.Bootstrap`.

## getDamageProfile

```lua
CyberM.vehicles.getDamageProfile(record)
```

`NETWORK` — Uses the network backend.

Returns a resource-local vehicle damage profile.

Reads the profile registered by the current server resource for the specified vehicle record. Profiles are not shared implicitly between resources.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `record` | `string` | required | — |

Returns: `profile table, or `nil``

Registered in `LuaResourceRuntime.cs` (line 2758) as `LuaResourceRuntime.Bootstrap`.

## isDoorOpen

```lua
CyberM.vehicles.isDoorOpen(id, door)
```

`NETWORK` — Uses the network backend.

Reads one canonical door opening state.

Server-side authoritative query covering four doors, trunk, and hood. Returns `nil` for an unknown vehicle ID.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `door` | `integer` | required | — |

Returns: `boolean, or `nil``

Registered in `LuaResourceRuntime.cs` (line 2738) as `LuaResourceRuntime.Bootstrap`.

## isWindowOpen

```lua
CyberM.vehicles.isWindowOpen(id, window)
```

`NETWORK` — Uses the network backend.

Reads one canonical side-window opening state.

Server-side authoritative query for indexes 0..3. It does not report broken glass and returns `nil` for an unknown vehicle.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `window` | `integer` | required | — |

Returns: `boolean, or `nil``

Registered in `LuaResourceRuntime.cs` (line 2748) as `LuaResourceRuntime.Bootstrap`.

## openDoor

```lua
CyberM.vehicles.openDoor(id, door)
```

`NETWORK` — Uses the network backend.

Opens a door, trunk, or hood.

Requires `world.vehicles`. Convenience wrapper over `setDoorOpen(id, door, true)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `door` | `integer` | required | — |

Returns: `boolean success`

```lua
CyberM.vehicles.openDoor(vehicleId, CyberM.vehicles.doors.trunk)
```

Registered in `LuaResourceRuntime.cs` (line 2736) as `LuaResourceRuntime.Bootstrap`.

## openWindow

```lua
CyberM.vehicles.openWindow(id, window)
```

`NETWORK` — Uses the network backend.

Opens one side window.

Requires `world.vehicles`. Convenience wrapper over `setWindowOpen(id, window, true)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `window` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2746) as `LuaResourceRuntime.Bootstrap`.

## registerDamageProfile

```lua
CyberM.vehicles.registerDamageProfile(record, profile)
```

`NETWORK` — Uses the network backend.

Registers resource-local named damage zones and glass parts.

Requires `world.vehicles`. Profiles are scoped to the calling server resource VM and can extend or override the default body-zone mapping for one vehicle record.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `record` | `string` | required | — |
| `profile` | `table` | required | — |

Returns: ``true``

Registered in `LuaResourceRuntime.cs` (line 2753) as `LuaResourceRuntime.Bootstrap`.

## remove

```lua
CyberM.vehicles.remove(id)
```

`NETWORK` — Uses the network backend.

Removes a server-owned network vehicle.

Requires `world.vehicles`. Only the resource that created the vehicle may remove it. Removal clears occupancy and authority before notifying streamed clients.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2767) as `LuaResourceRuntime.Bootstrap`.

## repair

```lua
CyberM.vehicles.repair(id, [scope])
```

`NETWORK` — Uses the network backend.

Repairs a selected vehicle damage scope.

Requires `world.vehicles`. Supported scopes are `glass`, `body`, `lights`, `tires`, `visual`, `mechanical`, and `full`. The default is `full`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `scope` | `string` | optional | `full` |

Returns: `boolean success`

```lua
CyberM.vehicles.repair(vehicleId, "visual")
```

Registered in `LuaResourceRuntime.cs` (line 2752) as `LuaResourceRuntime.Bootstrap`.

## repairAllGlass

```lua
CyberM.vehicles.repairAllGlass(id)
```

`NETWORK` — Uses the network backend.

Repairs all vehicle glass.

Requires `world.vehicles`. Clears the complete canonical broken-glass mask.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2716) as `LuaResourceRuntime.Bootstrap`.

## repairAllLights

```lua
CyberM.vehicles.repairAllLights(id)
```

`NETWORK` — Uses the network backend.

Repairs every vehicle light.

Requires `world.vehicles`. Clears the complete canonical broken-light mask.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2721) as `LuaResourceRuntime.Bootstrap`.

## repairAllTires

```lua
CyberM.vehicles.repairAllTires(id)
```

`NETWORK` — Uses the network backend.

Repairs all four vehicle tires.

Requires `world.vehicles`. Clears the complete canonical broken-tire mask.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2726) as `LuaResourceRuntime.Bootstrap`.

## repairBodyCell

```lua
CyberM.vehicles.repairBodyCell(id, cell)
```

`NETWORK` — Uses the network backend.

Repairs one body cell.

Requires `world.vehicles`. Sets the selected 1-based body cell to zero damage and replicates the repaired state.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `cell` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2701) as `LuaResourceRuntime.Bootstrap`.

## repairBodyZone

```lua
CyberM.vehicles.repairBodyZone(id, zone)
```

`NETWORK` — Uses the network backend.

Repairs every body cell in a zone.

Requires `world.vehicles`. Clears all cells selected by a registered zone name or explicit index array.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `zone` | `string|table` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2704) as `LuaResourceRuntime.Bootstrap`.

## repairGlass

```lua
CyberM.vehicles.repairGlass(id, glass)
```

`NETWORK` — Uses the network backend.

Repairs one vehicle glass element.

Requires `world.vehicles`. Convenience wrapper over `setGlassBroken(id, glass, false)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `glass` | `integer|string` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2711) as `LuaResourceRuntime.Bootstrap`.

## repairLight

```lua
CyberM.vehicles.repairLight(id, index)
```

`NETWORK` — Uses the network backend.

Repairs one vehicle light.

Requires `world.vehicles`. Convenience wrapper over `setLightBroken(id, index, false)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2720) as `LuaResourceRuntime.Bootstrap`.

## repairTire

```lua
CyberM.vehicles.repairTire(id, index)
```

`NETWORK` — Uses the network backend.

Repairs one vehicle tire.

Requires `world.vehicles`. Convenience wrapper over `setTireBroken(id, index, false)`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2725) as `LuaResourceRuntime.Bootstrap`.

## setBodyCell

```lua
CyberM.vehicles.setBodyCell(id, cell, value)
```

`NETWORK` — Uses the network backend.

Sets one body-damage cell.

Requires `world.vehicles`. Lua body-cell indexes are 1..30 and the value is clamped or validated in the normalized 0..1 range.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `cell` | `integer` | required | — |
| `value` | `number` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2696) as `LuaResourceRuntime.Bootstrap`.

## setBodyDamage

```lua
CyberM.vehicles.setBodyDamage(id, values)
```

`NETWORK` — Uses the network backend.

Replaces the complete body-damage grid.

Requires `world.vehicles`. The table must contain exactly 30 normalized finite values in the range 0..1.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `values` | `table` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2695) as `LuaResourceRuntime.Bootstrap`.

## setBodyZone

```lua
CyberM.vehicles.setBodyZone(id, zone, value)
```

`NETWORK` — Uses the network backend.

Sets all body cells in a zone.

Requires `world.vehicles`. The zone may be a registered zone name or an explicit array of cell indexes. Every selected cell receives the normalized value.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `zone` | `string|table` | required | — |
| `value` | `number` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2702) as `LuaResourceRuntime.Bootstrap`.

## setDamage

```lua
CyberM.vehicles.setDamage(id, damage)
```

`NETWORK` — Uses the network backend.

Replaces multiple canonical damage components at once.

Requires `world.vehicles`. Accepts a combined damage table and validates body cells and bit masks before publishing one authoritative update.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `damage` | `table` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2694) as `LuaResourceRuntime.Bootstrap`.

## setDoorMask

```lua
CyberM.vehicles.setDoorMask(id, mask)
```

`NETWORK` — Uses the network backend.

Replaces the vehicle opening mask.

Requires `world.vehicles`. The six-bit mask covers four doors, trunk, and hood. Valid values are 0..63.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `mask` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2727) as `LuaResourceRuntime.Bootstrap`.

## setDoorOpen

```lua
CyberM.vehicles.setDoorOpen(id, door, opened)
```

`NETWORK` — Uses the network backend.

Sets one door, trunk, or hood opening state.

Requires `world.vehicles`. `door` is an index 0..5 or one of the constants in `CyberM.vehicles.doors`.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `door` | `integer` | required | — |
| `opened` | `boolean` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2732) as `LuaResourceRuntime.Bootstrap`.

## setGlassBroken

```lua
CyberM.vehicles.setGlassBroken(id, glass, broken)
```

`NETWORK` — Uses the network backend.

Sets or clears one broken-glass bit.

Requires `world.vehicles`. `glass` may be a numeric 0..31 index or a name supplied by the resource's registered damage profile.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `glass` | `integer|string` | required | — |
| `broken` | `boolean` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2706) as `LuaResourceRuntime.Bootstrap`.

## setGlassMask

```lua
CyberM.vehicles.setGlassMask(id, mask)
```

`NETWORK` — Uses the network backend.

Replaces the broken-glass bit mask.

Requires `world.vehicles`. The 32-bit mask describes destructible glass records, not the four reversible side-window opening states.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `mask` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2705) as `LuaResourceRuntime.Bootstrap`.

## setLightBroken

```lua
CyberM.vehicles.setLightBroken(id, index, broken)
```

`NETWORK` — Uses the network backend.

Sets or clears one broken-light bit.

Requires `world.vehicles`. The light index must be in 0..31.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |
| `broken` | `boolean` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2718) as `LuaResourceRuntime.Bootstrap`.

## setLightMask

```lua
CyberM.vehicles.setLightMask(id, mask)
```

`NETWORK` — Uses the network backend.

Replaces the broken-light bit mask.

Requires `world.vehicles`. Replaces the complete 32-bit canonical broken-light mask.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `mask` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2717) as `LuaResourceRuntime.Bootstrap`.

## setTireBroken

```lua
CyberM.vehicles.setTireBroken(id, index, broken)
```

`NETWORK` — Uses the network backend.

Sets or clears one broken tire.

Requires `world.vehicles`. Mutates one tire index in 0..3 and replicates the canonical state to streamed observers.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `index` | `integer` | required | — |
| `broken` | `boolean` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2723) as `LuaResourceRuntime.Bootstrap`.

## setTireMask

```lua
CyberM.vehicles.setTireMask(id, mask)
```

`NETWORK` — Uses the network backend.

Replaces the broken-tire bit mask.

Requires `world.vehicles`. Only the lower four bits are valid and correspond to tire indexes 0..3.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `mask` | `integer` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2722) as `LuaResourceRuntime.Bootstrap`.

## setTransform

```lua
CyberM.vehicles.setTransform(id, transform)
```

`NETWORK` — Uses the network backend.

Moves a vehicle authoritatively.

Requires `world.vehicles`. Updates position and yaw, revokes any active physics lease, and publishes the new canonical transform to current viewers.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `transform` | `table` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2760) as `LuaResourceRuntime.Bootstrap`.

## setWindowOpen

```lua
CyberM.vehicles.setWindowOpen(id, window, opened)
```

`NETWORK` — Uses the network backend.

Sets one reversible side-window opening state.

Requires `world.vehicles`. This controls the four openable side windows and is separate from destructible broken-glass state.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `window` | `integer` | required | — |
| `opened` | `boolean` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2742) as `LuaResourceRuntime.Bootstrap`.

## update

```lua
CyberM.vehicles.update(id, patch)
```

`NETWORK` — Uses the network backend.

Updates canonical durable vehicle fields.

Requires `world.vehicles`. Applies only supplied fields, such as health, flags, colors, door/window/tire masks, body damage, broken glass, or broken lights. The authoritative result is persisted and replicated to current viewers and late joiners.

| Parameter | Type | Required | Default |
|---|---|---|---|
| `id` | `integer` | required | — |
| `patch` | `table` | required | — |

Returns: `boolean success`

Registered in `LuaResourceRuntime.cs` (line 2692) as `LuaResourceRuntime.Bootstrap`.