Class Delay

Helper with methods to suspend the game for various amounts of time.

Hierarchy

Delay

Index

Constructors

Accessors

Methods

beat cancelAll long seconds short

Constructors

constructor

new Delay(): Delay
Returns Delay

Accessors

anyActive

get anyActive(): boolean
True if any delays are currently running.

Returns boolean

Methods

beat

beat(): Promise<void>
Very short delay of 1 second.

Returns Promise<void>
A promise that fulfils after 1 seconds

cancelAll

cancelAll(reason?): void
Parameters
- Optional reason: any
Returns void

long

long(): Promise<void>
Long delay of 2 seconds.

Returns Promise<void>
A promise that fulfils after 3 seconds.

seconds

seconds(value): Promise<void>
Delay for an arbitrary amount of time.
Parameters
- value: number
  
  How long to delay for, in seconds.
Returns Promise<void>
A promise that fulfils after the given time.

short

short(): Promise<void>
Short delay of 1 second.

Returns Promise<void>
A promise that fulfils after 2 seconds.

Generated using TypeDoc