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.
| Export | Parameters | Returns | What it does |
|---|---|---|---|
IsChirping | vehicle: number | boolean | On the chirp list? Answers from the last list received, not the frame |
IsSirenActive | vehicle: number | boolean | Siren 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.
| Event | Arguments | When |
|---|---|---|
tchirp:armed | netId: number | A vehicle is now on the chirp list |
tchirp:cleared | netId: number | A vehicle has left it |
Network events
Everything the server accepts is validated against config.lua. Only AddChirpVehicle is gated by Config.access.
| Event | Direction | Arguments |
|---|---|---|
tchirp:AddChirpVehicle | client → server | netId, soundCfg: { sound, ref } |
tchirp:RemoveChirpVehicle | client → server | netId |
tchirp:RequestChirpList | client → server | none |
tchirp:SyncChirpList | server → client | list 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
| Command | Who | What |
|---|---|---|
/tchirp | anyone, client-side | Status dialog, plus a Silence button. Full row list |
tchirp_diag | console, or command.tchirp_diag | Version, 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.
Tommy's Chirp
Still stuck? Support can answer it directly.
Was this page helpful?
TIMMYG Studios