Skip to content

API reference

tChirp's two client exports, two client events, the wire protocol and two commands.

Two client exports, two client-side events, two commands. None of it is needed to use tChirp.

Exports

Both client-side, and both exports.tChirp.

ExportParametersReturnsWhat it does
IsChirpingvehicle: numberbooleanOn the chirp list? Answers from the last list received, not the frame
IsSirenActivevehicle: numberbooleanSiren on, per the owning provider. Respects Config.sirenSystem

IsSirenActive reports the siren, not the lights and not park-kill state, so a park-killed car returns false.

Events

Local, raised with TriggerEvent. Both fire on every client, not only the one that parked the car.

EventArgumentsWhen
tchirp:armednetId: numberA vehicle is now on the chirp list
tchirp:clearednetId: numberA vehicle has left it

Network events

Everything the server accepts is validated against config.lua. Only AddChirpVehicle is gated by Config.access.

EventDirectionArguments
tchirp:AddChirpVehicleclient → servernetId, soundCfg: { sound, ref }
tchirp:RemoveChirpVehicleclient → servernetId
tchirp:RequestChirpListclient → servernone
tchirp:SyncChirpListserver → clientlist keyed by netId

The tChirp: spellings are gone in 2.0.0

Lowercase tchirp: is the only form; the verbs are unchanged. Rename every tChirp: name in your code: a stale listener never runs, a stale trigger goes nowhere.

Commands

CommandWhoWhat
/tchirpanyone, client-sideStatus dialog, plus a Silence button. Full row list
tchirp_diagconsole, or command.tchirp_diagVersion, tLib version, access, provider, timing, counts, fresh config check

tchirp_diag is restricted: add_ace group.admin command.tchirp_diag allow. It reports the configuration at startup, not the live table.

Still stuck? Support can answer it directly.

Was this page helpful?