FivePD API
Interfaces

IAssistanceServiceManagerService

Responsible for managing the assistance services.

Methods

CallAsync

Calls an assistance service.

Parameters

NameTypeDescription
requestedByFPlayerThe player who requested the assistance service.
onCanceledActionThe action to invoke when the assistance service is canceled.

Returns

NameType
Task<Guid>The GUID of the assistance service.

CallAsync

Calls an assistance service.

Parameters

NameTypeDescription
typeTypeThe type.
requestedByFPlayerThe player who requested the assistance service.
onCanceledActionThe action to invoke when the assistance service is canceled.

Returns

NameType
Task<Guid>The GUID of the assistance service.

Cancel

Cancels an assistance service. The GUID will be set to Guid.Empty.

Parameters

NameTypeDescription
guidref GuidThe GUID of the assistance service.

Properties

AvailableServices

Gets all registered assistance services.

Type: IReadOnlyList<AvailableAssistanceService>