export abstract Class
Event ​
extends ​
Piece<EventMeta>
An event piece.
Constructor ​
ts
new Event( context_piece, context_metadata )| Parameter | Type | Description |
|---|---|---|
context_piece | PieceContext | |
context_metadata | EventMeta |
Properties ​
get enabled : boolean ​
readonly client : Client ​
emitter : any ​
event : string ​
name : ClientEvent ​
once : boolean ​
registry : EventsRegistry ​
Methods ​
disable( ) ​
Stops and disables the piece.
Returns:
void
enable( resume ) ​
| Parameter | Type | Description |
|---|---|---|
resume? | boolean | Wether to resume the piece, must be enabled. |
Enables the piece.
Returns:
void
listen( ) ​
Activates or resumes the listener, this is activated on load.
Returns:
void
run( ...args ) ​
| Parameter | Type | Description |
|---|---|---|
...args | unknown[] |
Returns:
unknown
stop( ) ​
Stops the listener.
Returns:
void