Exports

FRKN-Dispatch – Client Exports Guide

All exports must be called on the client side.

1) Quick Start

Bank Robberies (requires camera ID)

exports['frkn-dispatch']:FleecaBankRobbery(1)
exports['frkn-dispatch']:PacificBankRobbery(2)
exports['frkn-dispatch']:PaletoBankRobbery(3)

Vehicle Alerts (requires vehicle entity)

local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
exports['frkn-dispatch']:CarBoosting(vehicle)
exports['frkn-dispatch']:VehicleTheft(vehicle)
exports['frkn-dispatch']:SpeedingVehicle(vehicle)

Simple Alerts (no params)

exports['frkn-dispatch']:HouseRobbery()
exports['frkn-dispatch']:OfficerDown()
exports['frkn-dispatch']:Shooting()

2) Full API Reference

Unless stated otherwise, exports do not require parameters. camId = number, the linked camera ID. vehicle = vehicle entity handle.

  • exports['frkn-dispatch']:ArtGalleryRobbery()

  • exports['frkn-dispatch']:CarBoosting(vehicle)

  • exports['frkn-dispatch']:CarJacking(vehicle)

  • exports['frkn-dispatch']:CustomAlert(dataTable)

  • exports['frkn-dispatch']:DeceasedPerson()

  • exports['frkn-dispatch']:DrugBoatRobbery()

  • exports['frkn-dispatch']:DrugSale()

  • exports['frkn-dispatch']:EmsDown()

  • exports['frkn-dispatch']:Explosion()

  • exports['frkn-dispatch']:Fight()

  • exports['frkn-dispatch']:FleecaBankRobbery(camId)

  • exports['frkn-dispatch']:HouseRobbery()

  • exports['frkn-dispatch']:HumaneRobbery()

  • exports['frkn-dispatch']:Hunting()

  • exports['frkn-dispatch']:InjuriedPerson()

  • exports['frkn-dispatch']:OfficerDown()

  • exports['frkn-dispatch']:OfficerBackup()

  • exports['frkn-dispatch']:OfficerInDistress()

  • exports['frkn-dispatch']:PacificBankRobbery(camId)

  • exports['frkn-dispatch']:PaletoBankRobbery(camId)

  • exports['frkn-dispatch']:PrisonBreak()

  • exports['frkn-dispatch']:Shooting()

  • exports['frkn-dispatch']:SignRobbery()

  • exports['frkn-dispatch']:SpeedingVehicle(vehicle)

  • exports['frkn-dispatch']:StoreRobbery(camId)

  • exports['frkn-dispatch']:SuspiciousActivity()

  • exports['frkn-dispatch']:TrainRobbery()

  • exports['frkn-dispatch']:UndergroundRobbery()

  • exports['frkn-dispatch']:UnionRobbery()

  • exports['frkn-dispatch']:VangelicoRobbery(camId)

  • exports['frkn-dispatch']:VanRobbery()

  • exports['frkn-dispatch']:VehicleShooting(vehicle)

  • exports['frkn-dispatch']:VehicleTheft(vehicle)

  • exports['frkn-dispatch']:YachtHeist()

  • exports['frkn-dispatch']:BobcatSecurityHeist()


3) Real-World Examples

Robbery Script Integration

Police Script Integration

Vehicle Script Integration


4) Custom Alert

Fields:

  • message / code / dispatchCode: text and code info

  • icon: Font Awesome icon class

  • priority: number (1–3)

  • alert.sprite, alert.scale: blip customization

  • coords: player coordinates


5) Creating a New Alert

5.1 Add client function

5.2 Add blip config

The codeName must match the dispatchData.codeName in your client function.


6) Notes & Tips

  • For robbery exports with camId, always provide a valid camera ID.

  • For vehicle-based exports, make sure vehicle is a valid entity handle.

  • All exports must be called from the client.

Last updated