Class DeferralManager`No Self`

Static class that manages deferrals for connecting players.

Index

Constructors

Methods

addDeferral defer getDeferral removeDeferral

Constructors

constructor

new DeferralManager(): DeferralManager
Returns DeferralManager

Methods

`Static`addDeferral

addDeferral(name, deferral): void
Adds a deferral to the deferral queue.
Parameters
- name: string
  Unique name for the deferral.
- deferral: Deferral
  The deferral function to add.
Returns void
- Defined in deferrals/deferralManager.ts:41

`Static`defer

defer(playerName, setKickReason, deferrals): void
Parameters
- playerName: string
  Steam / Client name of the connecting player
- setKickReason: KickFunction
  Function to set the kick reason (does not seem to work)
- deferrals: any
  Deferral object provided by the Cfx.re framework
Returns void
- Defined in deferrals/deferralManager.ts:71

`Static`getDeferral

getDeferral(name): Optional<Deferral>
Gets a deferral function from the deferral queue.
Parameters
- name: string
  Unique name of the deferral to get.
Returns Optional<Deferral>
The deferral function if it exists, otherwise None.
- Defined in deferrals/deferralManager.ts:60

`Static`removeDeferral

removeDeferral(name): void
Removes a deferral from the deferral queue.
Parameters
- name: string
  Unique name of the deferral to remove.
Returns void
- Defined in deferrals/deferralManager.ts:50