CyberM.vehicles

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

server runtime43 functionsMarkdown

all

NETWORK

CyberM.vehicles.all([bucket])

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.

Parameters

  • bucketintegeroptional

Returns

  • array of vehicle tables

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

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

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.

Parameters

  • idintegerrequired
  • countintegeroptionaldefault 32

Returns

  • boolean success

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

breakGlass

NETWORK

CyberM.vehicles.breakGlass(id, glass)

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.

Parameters

  • idintegerrequired
  • glassinteger|stringrequired

Returns

  • boolean success

Example

CyberM.vehicles.breakGlass(vehicleId, 0)

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

breakLight

NETWORK

CyberM.vehicles.breakLight(id, index)

Breaks one vehicle light.

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

Parameters

  • idintegerrequired
  • indexintegerrequired

Returns

  • boolean success

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

breakTire

NETWORK

CyberM.vehicles.breakTire(id, index)

Breaks one vehicle tire.

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

Parameters

  • idintegerrequired
  • indexintegerrequired

Returns

  • boolean success

Example

CyberM.vehicles.breakTire(vehicleId, 0)

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

closeDoor

NETWORK

CyberM.vehicles.closeDoor(id, door)

Closes a door, trunk, or hood.

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

Parameters

  • idintegerrequired
  • doorintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.closeWindow(id, window)

Closes one side window.

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

Parameters

  • idintegerrequired
  • windowintegerrequired

Returns

  • boolean success

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

create

NETWORK

CyberM.vehicles.create(definition)

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.

Parameters

  • definitiontablerequired

Returns

  • vehicle ID, or nil, reason

Example

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 as LuaResourceRuntime.Bootstrap (line 2677).

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

Adds damage to one body cell.

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

Parameters

  • idintegerrequired
  • cellintegerrequired
  • amountnumberrequired

Returns

  • boolean success

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

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

Adds damage across a body zone.

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

Parameters

  • idintegerrequired
  • zonestring|tablerequired
  • amountnumberrequired

Returns

  • boolean success

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

get

NETWORK

CyberM.vehicles.get(id)

Returns one authoritative server vehicle snapshot.

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

Parameters

  • idintegerrequired

Returns

  • vehicle table, or nil

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

getDamage

NETWORK

CyberM.vehicles.getDamage(id)

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.

Parameters

  • idintegerrequired

Returns

  • damage table, or nil

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

CyberM.vehicles.getDamageProfile(record)

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.

Parameters

  • recordstringrequired

Returns

  • profile table, or nil

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

isDoorOpen

NETWORK

CyberM.vehicles.isDoorOpen(id, door)

Reads one canonical door opening state.

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

Parameters

  • idintegerrequired
  • doorintegerrequired

Returns

  • boolean, or nil

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

CyberM.vehicles.isWindowOpen(id, window)

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.

Parameters

  • idintegerrequired
  • windowintegerrequired

Returns

  • boolean, or nil

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

openDoor

NETWORK

CyberM.vehicles.openDoor(id, door)

Opens a door, trunk, or hood.

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

Parameters

  • idintegerrequired
  • doorintegerrequired

Returns

  • boolean success

Example

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

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

openWindow

NETWORK

CyberM.vehicles.openWindow(id, window)

Opens one side window.

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

Parameters

  • idintegerrequired
  • windowintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.registerDamageProfile(record, profile)

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.

Parameters

  • recordstringrequired
  • profiletablerequired

Returns

  • true

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

remove

NETWORK

CyberM.vehicles.remove(id)

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.

Parameters

  • idintegerrequired

Returns

  • boolean success

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

repair

NETWORK

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

Repairs a selected vehicle damage scope.

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

Parameters

  • idintegerrequired
  • scopestringoptionaldefault full

Returns

  • boolean success

Example

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

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

CyberM.vehicles.repairAllGlass(id)

Repairs all vehicle glass.

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

Parameters

  • idintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.repairAllLights(id)

Repairs every vehicle light.

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

Parameters

  • idintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.repairAllTires(id)

Repairs all four vehicle tires.

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

Parameters

  • idintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.repairBodyCell(id, cell)

Repairs one body cell.

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

Parameters

  • idintegerrequired
  • cellintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.repairBodyZone(id, zone)

Repairs every body cell in a zone.

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

Parameters

  • idintegerrequired
  • zonestring|tablerequired

Returns

  • boolean success

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

CyberM.vehicles.repairGlass(id, glass)

Repairs one vehicle glass element.

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

Parameters

  • idintegerrequired
  • glassinteger|stringrequired

Returns

  • boolean success

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

CyberM.vehicles.repairLight(id, index)

Repairs one vehicle light.

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

Parameters

  • idintegerrequired
  • indexintegerrequired

Returns

  • boolean success

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

repairTire

NETWORK

CyberM.vehicles.repairTire(id, index)

Repairs one vehicle tire.

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

Parameters

  • idintegerrequired
  • indexintegerrequired

Returns

  • boolean success

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

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

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.

Parameters

  • idintegerrequired
  • cellintegerrequired
  • valuenumberrequired

Returns

  • boolean success

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

CyberM.vehicles.setBodyDamage(id, values)

Replaces the complete body-damage grid.

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

Parameters

  • idintegerrequired
  • valuestablerequired

Returns

  • boolean success

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

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

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.

Parameters

  • idintegerrequired
  • zonestring|tablerequired
  • valuenumberrequired

Returns

  • boolean success

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

setDamage

NETWORK

CyberM.vehicles.setDamage(id, damage)

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.

Parameters

  • idintegerrequired
  • damagetablerequired

Returns

  • boolean success

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

CyberM.vehicles.setDoorMask(id, mask)

Replaces the vehicle opening mask.

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

Parameters

  • idintegerrequired
  • maskintegerrequired

Returns

  • boolean success

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

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

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.

Parameters

  • idintegerrequired
  • doorintegerrequired
  • openedbooleanrequired

Returns

  • boolean success

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

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

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.

Parameters

  • idintegerrequired
  • glassinteger|stringrequired
  • brokenbooleanrequired

Returns

  • boolean success

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

CyberM.vehicles.setGlassMask(id, mask)

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.

Parameters

  • idintegerrequired
  • maskintegerrequired

Returns

  • boolean success

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

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

Sets or clears one broken-light bit.

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

Parameters

  • idintegerrequired
  • indexintegerrequired
  • brokenbooleanrequired

Returns

  • boolean success

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

CyberM.vehicles.setLightMask(id, mask)

Replaces the broken-light bit mask.

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

Parameters

  • idintegerrequired
  • maskintegerrequired

Returns

  • boolean success

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

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

Sets or clears one broken tire.

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

Parameters

  • idintegerrequired
  • indexintegerrequired
  • brokenbooleanrequired

Returns

  • boolean success

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

CyberM.vehicles.setTireMask(id, mask)

Replaces the broken-tire bit mask.

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

Parameters

  • idintegerrequired
  • maskintegerrequired

Returns

  • boolean success

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

CyberM.vehicles.setTransform(id, transform)

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.

Parameters

  • idintegerrequired
  • transformtablerequired

Returns

  • boolean success

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

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

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.

Parameters

  • idintegerrequired
  • windowintegerrequired
  • openedbooleanrequired

Returns

  • boolean success

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

update

NETWORK

CyberM.vehicles.update(id, patch)

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.

Parameters

  • idintegerrequired
  • patchtablerequired

Returns

  • boolean success

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

For agents and LLMs: this page as Markdown · llms.txt · llms-full.txt