ai-sirens for developers

ai-sirens has client exports only. They do the same as the driver's keys. vehicle is optional: without it, the vehicle the player sits in is used. A vehicle that is not an emergency vehicle (class 18 and in the panel's model list) is ignored.

Lua calls them as exports['ai-sirens']:Name(...). They are not typed in @aicore-fivem/shared: in TypeScript use callExport("ai-sirens", "Name", ...args) from @aicore-fivem/lib/client.

Client exportsCopy Anchor Link

SetLightsCopy Anchor Link

Turns the emergency lights on or off (and the ONX lightbar's, if any).

Side: Client · Waits: no

SetLights(vehicle: number | undefined, on: boolean): boolean

local ok = exports['ai-sirens']:SetLights(vehicle, true)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

true when the vehicle is an emergency vehicle and the lights were set. false otherwise.

ToggleLightsCopy Anchor Link

Flips the emergency lights.

Side: Client · Waits: no

ToggleLights(vehicle?: number): boolean

local ok = exports['ai-sirens']:ToggleLights()

ReturnsCopy Anchor Link

true when the vehicle is an emergency vehicle. false otherwise.

SetSirenToneCopy Anchor Link

Sets the main siren tone. A tone above 0 turns the lights on first.

Side: Client · Waits: no (the server answers later; the local value shows at once)

SetSirenTone(vehicle: number | undefined, tone: 0 | 1 | 2 | 3): boolean

local ok = exports['ai-sirens']:SetSirenTone(nil, 2)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

true when the request was sent. false for a vehicle that is not an emergency vehicle or a tone outside 0-3. A request the server does not confirm within 1.5 seconds counts as refused and the old tone shows again.

ExampleCopy Anchor Link

import { callExport } from "@aicore-fivem/lib/client";

// A pursuit script: tone 2 when the chase starts.
export function startPursuit(): void {
  if (!callExport("ai-sirens", "SetSirenTone", undefined, 2)) return;
  console.log("pursuit tone on");
}

ToggleSirenCopy Anchor Link

Stops the siren if it runs, otherwise starts it on tone 1 (turning the lights on first).

Side: Client · Waits: no

ToggleSiren(vehicle?: number): boolean

local ok = exports['ai-sirens']:ToggleSiren()

ReturnsCopy Anchor Link

true when the request was sent, false for a vehicle that is not an emergency vehicle.

CycleToneCopy Anchor Link

The next tone: 1, 2, 3, then 1 again. With the siren off it starts tone 1 (turning the lights on first).

Side: Client · Waits: no

CycleTone(vehicle?: number): boolean

local ok = exports['ai-sirens']:CycleTone()

ReturnsCopy Anchor Link

true when the request was sent, false for a vehicle that is not an emergency vehicle.

GetSirenToneCopy Anchor Link

The current main siren tone.

Side: Client · Waits: no

GetSirenTone(vehicle?: number): number

local tone = exports['ai-sirens']:GetSirenTone(vehicle)

ReturnsCopy Anchor Link

0 (off) to 3. Also 0 for a vehicle that is not an emergency vehicle.

AreLightsOnCopy Anchor Link

Whether the emergency lights are on.

Side: Client · Waits: no

AreLightsOn(vehicle?: number): boolean

local on = exports['ai-sirens']:AreLightsOn(vehicle)

ReturnsCopy Anchor Link

true when on. false when off or not an emergency vehicle.

GetAirManuStateCopy Anchor Link

The airhorn and manual siren state.

Side: Client · Waits: no

GetAirManuState(vehicle?: number): number

local state = exports['ai-sirens']:GetAirManuState(vehicle)

ReturnsCopy Anchor Link

0 off, 1 airhorn, 2 manual siren, 3 both. 0 for a vehicle that is not an emergency vehicle.

GetLightbarModelCopy Anchor Link

The ONX lightbar model attached to the vehicle.

Side: Client · Waits: no

GetLightbarModel(vehicle?: number): string | null

local model = exports['ai-sirens']:GetLightbarModel(vehicle)

ReturnsCopy Anchor Link

The model name ("onx_pol_lbar_mdn1a"), or null when the vehicle has none or is not an emergency vehicle.

State bagsCopy Anchor Link

Written only by the server after its checks. Read them on any client to know a vehicle's siren state.

local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
local tone = Entity(vehicle).state['siren:lx'] or 0

EventsCopy Anchor Link