SAF Pursuit Configuration | SAF Scripts Docs

Everything is in config.lua. Framework hooks (who is police, jobs, vehicles, logs) are in bridge/, covered in Custom servers.

General

Option	Default	What it does
`Config.Framework`	`'auto'`	`'auto'`, `'qbx'`, `'qb'`, `'esx'`, `'nd'`, `'ox'` or `'standalone'`

Who can use modes

Option	Default	What it does
`Config.Ace`	`'pursuit.use'`	ACE that always allows modes
`Config.PoliceJobs`	`police`, `sheriff`, `bcso`, `sasp`, `state`, `trooper`, `ranger`, `fib`	Jobs that count as police
`Config.PoliceJobTypes`	`{ leo = true }`	Qbox and QBCore job types that also count
`Config.RequireOnDuty`	`true`	Police must be on duty

Vehicles

Option	Default	What it does
`Config.Vehicles.EmergencyOnly`	`true`	`false` lets police switch modes in any vehicle they drive
`Config.Vehicles.Classes`	`{ [18] = true }`	Vehicle classes that take a mode. 18 is Emergency
`Config.Vehicles.Models`	empty	Extra spawn codes that count, for unmarked cars and addon packs

Modes

Config.Modes lists the modes in the order the key cycles them, after OFF. Each mode:

Key	What it does
`id`	Mode letter, shown on the display and used by `/pursuit a`
`name`	Name shown with the mode
`Power`	Engine torque multiplier. `1.0` is stock
`TopSpeed`	Top speed boost in percent. `0` is stock
`MaxMph`	Hard speed cap in mph. `0` is no cap. Shown on the display
`Brakes`	Brake force multiplier
`Grip`	Tyre grip multiplier
`Suspension`	Spring stiffness multiplier
`AntiRoll`	Anti-roll bar multiplier. Higher is less body roll in hard corners
`Pursuit`	Counts as "in pursuit" for the exports, the PIT helper and auto off

Lua

Config.Modes = {
    { id = 'A', name = 'Patrol',   Power = 1.00, TopSpeed = 0,  MaxMph = 105, Brakes = 1.00, Grip = 1.00, Suspension = 1.00, AntiRoll = 1.00, Pursuit = false },
    { id = 'B', name = 'Response', Power = 1.15, TopSpeed = 6,  MaxMph = 125, Brakes = 1.10, Grip = 1.04, Suspension = 1.05, AntiRoll = 1.15, Pursuit = true },
    { id = 'C', name = 'Pursuit',  Power = 1.30, TopSpeed = 12, MaxMph = 0,   Brakes = 1.20, Grip = 1.08, Suspension = 1.10, AntiRoll = 1.30, Pursuit = true },
}

Per-model overrides

Config.ModelOverrides changes values on top of a mode for one spawn code. Only the values you list change.

Lua

Config.ModelOverrides = {
    police3 = { C = { Power = 1.25, MaxMph = 140 } },
    policeb = { B = { Grip = 1.0 }, C = { Grip = 1.0, AntiRoll = 1.0 } },
}

Switching

Option	Default	What it does
`Config.Key`	`'J'`	Default key that cycles OFF, A, B, C. Players can rebind it
`Config.Command`	`'pursuit'`	`/pursuit` cycles, `/pursuit a`, `b`, `c` or `off` picks one
`Config.Cooldown`	`1500`	Milliseconds between switches
`Config.Sound`	`NAV_LEFT_RIGHT`	`{ name, set }` of a frontend sound on every switch. `false` is silent
`Config.Notify`	`true`	Small notification on every switch

Auto off

Drops back to OFF after sitting slow, only from modes marked Pursuit.

Option	Default	What it does
`Config.AutoOff.Enabled`	`true`	Turn auto off on or off
`Config.AutoOff.BelowMph`	`10`	Counts as slow under this speed
`Config.AutoOff.Seconds`	`45`	Seconds slow before the mode goes off

Unit display

Option	Default	What it does
`Config.Hud.Enabled`	`true`	Show the display
`Config.Hud.Position`	`'bottom-right'`	`'bottom-right'`, `'bottom-left'`, `'top-right'`, `'top-left'` or `'bottom-center'`
`Config.Hud.OffsetX`	`28`	Pixels from the screen edge, at 1080p
`Config.Hud.OffsetY`	`300`	Pixels from the screen edge, at 1080p
`Config.Hud.Scale`	`1.0`	Size of the display
`Config.Hud.ShowWhenOff`	`true`	Keep the small mode strip up while OFF in a police vehicle
`Config.Hud.Units`	`'mph'`	`'mph'` or `'kmh'`

PIT helper

In the modes listed here, the display picks the vehicle you're closing on and says which side to PIT and whether speed, angle and contact point are in the window.

Option	Default	What it does
`Config.Pit.Enabled`	`true`	Turn the PIT helper on or off
`Config.Pit.Modes`	`{ B = true, C = true }`	Modes that show the helper
`Config.Pit.Range`	`30.0`	Metres ahead a target is picked up
`Config.Pit.MinMph`	`15`	Lowest speed for a PIT
`Config.Pit.MaxMph`	`60`	Above this a PIT is not authorised and the display shows the limit in red
`Config.Pit.MaxSpeedDiff`	`15`	Mph difference allowed between you and the target
`Config.Pit.MaxAngle`	`20`	Degrees allowed between your heading and theirs
`Config.Pit.Assist`	`'light'`	`'off'`, `'light'` or `'full'`. `'off'` keeps the helper and the logs, no push
`Config.Pit.AssistStrength`	`{ light = 2.0, full = 3.5 }`	Sideways push at the target's rear, in m/s
`Config.Pit.Cooldown`	`8`	Seconds between assisted PITs per officer
`Config.Pit.TargetCooldown`	`6`	Seconds before the same vehicle can be assisted again
`Config.Pit.MaxDistance`	`8.0`	Server check: most metres between the two vehicles

Logging

Option	Default	What it does
`Config.Log.Modes`	`true`	Log every mode change
`Config.Log.Pits`	`true`	Log every assisted PIT

Logs go to the server console through Bridge.Log. Replace it to send them anywhere else.