Skip to main content

Backup API

Handles public methods for interacting with PR's backup system.

warning

Calling any method with a dispatchAnim parameter set to true will hold up the fiber (that the method was called on) until the animation is done.

Requesting Backup​

RequestBackup() at player position​

Creates and dispatches the requested unit to the player's current position. For air units refer to RequestAirBackup and for prisoner transport refer to RequestPoliceTransport.

public static bool RequestBackup(EBackupUnit unit, EBackupResponseCode responseCode, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestBackup() at provided position​

Creates and dispatches the requested unit to the provided destination. For air units refer to RequestAirBackup and for prisoner transport refer to RequestPoliceTransport.

public static bool RequestBackup(EBackupUnit unit, EBackupResponseCode responseCode, Vector3 destination, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestTrafficStopBackup()​

Creates and dispatches the requested unit to an active traffic stop.

public static bool RequestTrafficStopBackup(EBackupUnit unit, EBackupResponseCode responseCode, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestAirBackup()​

Creates and dispatches the requested air unit to the current pursuit.

note

Only available during pursuits.

public static bool RequestAirBackup(EBackupUnit unit, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestPoliceTransport()​

Creates and dispatches a prisoner transport unit to pick up the nearest arrested suspect.

public static bool RequestPoliceTransport(EBackupResponseCode responseCode, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestPanicBackup() at player position​

Creates and dispatches panic backup units to the player's current position.

public static bool RequestPanicBackup(bool dispatchNotif = true, bool dispatchAudio = true);

RequestPanicBackup() at provided position​

Creates and dispatches panic backup units to the provided destination.

public static bool RequestPanicBackup(Vector3 destination, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestGroupBackup() at player position​

Creates and dispatches defined group backup units to the player's current position.

public static bool RequestGroupBackup(bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestGroupBackup() at provided position​

Creates and dispatches group backup units to the provided destination.

public static bool RequestGroupBackup(Vector3 destination, bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestSpikeStripsBackup()​

Creates and dispatches a spike strips units to intercept a pursuit vehicle.

note

Only available during pursuits.

public static bool RequestSpikeStripsBackup(bool dispatchNotif = true, bool dispatchAnim = true, bool dispatchAudio = true);

RequestTowServiceBackup()​

Opens a UI menu where the player is able to choose what tow truck type it wants. Upon selecting the plugin will attempt to get the nearest vehicle and send the desired unit to tow it.

info

Will always show a dispatch notification and play a dispatch anim/audio.

public static bool RequestTowServiceBackup();

InitiateFelonyStop()​

Opens a UI menu where the player is able to choose in which mode the felony stop should be started.

note

Does not show any dispatch notification nor plays a dispatch anim/audio.

public static bool InitiateFelonyStop();

DismissAllBackupUnits()​

Dismisses all active and responding backup units.

public static void DismissAllBackupUnits(bool force = false);

Spawning Backup​

important

This method only spawns the entities into the world without any handling or AI by PR.

SpawnLocalBackup()​

Spawns a local variation of the requested unit at the specified position.

public static bool SpawnLocalBackup(EBackupUnit unit, Vector3 position, out Vehicle unitVehicle, out List<Ped> unitPeds);

SpawnLocalBackup()​

Spawns a position-local variation of the requested unit at the specified spawn position.

public static bool SpawnLocalBackup(EBackupUnit unit, Vector3 position, Vector3 spawnPosition, out Vehicle unitVehicle, out List<Ped> unitPeds);

SpawnLocalBackupVehicle()​

Spawns a local vehicle variation of the requested unit at the specified position.

public static Vehicle SpawnLocalBackupVehicle(EBackupUnit unit, Vector3 position, float heading);

SpawnLocalBackupVehicle()​

Spawns a position-local vehicle variation of the requested unit at the specified spawn position.

public static Vehicle SpawnLocalBackupVehicle(EBackupUnit unit, Vector3 position, Vector3 spawnPosition, float heading);

SpawnLocalBackupPeds()​

Spawns local ped variations of the requested unit at the specified position. Each ped is a randomized variant.

public static Ped[] SpawnLocalBackupPeds(EBackupUnit unit, Vector3 position, float heading, int amount, bool equipWeapons = false);

SpawnLocalBackupPeds()​

Spawns a position-local ped variation of the requested unit at the specified spawn position. Each ped is a randomized variant.

public static Ped[] SpawnLocalBackupPeds(EBackupUnit unit, Vector3 position, Vector3 spawnPosition, float heading, int amount, bool equipWeapons = false);
note

If you just need local models (e.g. for dimensions & other stuff) you can use these APIs.

GetLocalBackupVehicleModels()​

Returns an array of all local vehicle models of the requested unit.

public static Model[] GetLocalBackupVehicleModels(EBackupUnit unit, Vector3 position);

GetLocalBackupPedModels()​

Returns an array of all local ped models of the requested unit.

public static Model[] GetLocalBackupPedModels(EBackupUnit unit, Vector3 position);

Enums​

EBackupUnit​

Represents all requestable backup units.

public enum EBackupUnit
{
    LocalPatrol,
    LocalFemalePatrol,
    StatePatrol,
    StateFemalePatrol,
    LocalSWAT,
    NooseSWAT,
    LocalK9Patrol,
    StateK9Patrol,
    LocalAir,
    NooseAir,
    PoliceTransport,
    Ambulance,
    FireDepartment,
    Coroner,
    SmallTowTruck,
    LargeTowTruck,
    FlatbedTowTruck,
    AnimalControl
}

Definitions​

Pretty self-explanatory.