FivePD API
Interfaces

IIncidentService

Represents the service that handles incidents.

Methods

GetCurrentIncidentOfPlayer

Gets the incident of the specified player.

Parameters

NameTypeDescription
playerFPlayerThe player to get the incident of.

Returns

NameType
IIncidentThe incident of the specified player.

GetById

Retrieves the incident with the specified identifier.

Parameters

NameTypeDescription
idGuidThe unique identifier of the incident to retrieve.

Returns

NameType
IIncidentThe incident associated with the specified identifier.

AssignUnitToIncident

Assigns the specified unit to the given incident.

Parameters

NameTypeDescription
unitUnitThe unit to assign to the incident.
incidentIIncidentThe incident to which the unit should be assigned.

Returns

NameType
boolA boolean value indicating whether the unit was successfully assigned to the incident.

UnassignUnitFromIncident

Unassigns the specified unit from the given incident.

Parameters

NameTypeDescription
unitUnitThe unit to be unassigned from the incident.
incidentIIncidentThe incident from which the unit will be unassigned.

Returns

NameType
boolA boolean value indicating whether the unit was successfully unassigned from the incident.

CompleteIncidentOfPlayer

Completes the incident of the specified player.

Parameters

NameTypeDescription
playerFPlayerThe player to complete the incident of.

CompleteIncident

Completes the specified incident.

Parameters

NameTypeDescription
incidentIIncidentThe incident to complete.

CompleteIncident

Completes the specified incident.

Parameters

NameTypeDescription
idGuidThe id of the incident to complete.

Properties

ActiveCallouts

Gets the active callouts.

Type: ReadOnlyCollection<Callout>

TrafficStops

Gets the active traffic stops.

Type: ReadOnlyCollection<TrafficStop>

InternalCallouts

Type: List<InternalCallout>

InternalTrafficStops

Gets the internal traffic stops.

Type: List<TrafficStop>

Events

OnCalloutCompleted

Invoked when a callout is completed.

Type: EventHandler<Callout>