FivePD API
Interfaces

ISceneManagementService

Responsible for handling scene management related tasks.

Methods

SpeedZones

Gets the speed zones.

Returns

NameType
List<SpeedZone>A list of speed zones.

CreateSpeedZone

Creates a speed zone.

Parameters

NameTypeDescription
positionVector3The position.
radiusintThe radius.
speedintThe maximum speed.

Returns

NameType
GuidThe id of the created speed zone.

DeleteSpeedZone

Deletes the speed zone with the specified id.

Parameters

NameTypeDescription
idGuidThe id of the speed zone to delete.

Returns

NameType
boolA value indicating whether the deletion could be completed or not.

ReleaseSpeedZoneTraffic

Releases the traffic for a given speed zone.

Parameters

NameTypeDescription
idGuidThe id of the speed zone.

Events

SpeedZoneCreated

Fires when a speed zone has been created.

Type: EventHandler<SpeedZoneCreatedEventArgs>

SpeedZoneDeleted

Fires when a speed zone has been deleted.

Type: EventHandler<SpeedZoneDeletedEventArgs>