meshcore.js
ReferenceClasses

EventBuilder<E>

Defined in: packages/client/src/events/event-builder.ts:16

What every builder (CommandBuilder, EventBuilder, …) produces: a build() method tagged with its kind.

Type Parameters

E

E extends EventName = EventName

Implements

Constructors

Constructor

new EventBuilder<E>(): EventBuilder<E>;

Returns

EventBuilder<E>

Properties

[BRICK]

readonly [BRICK]: "event";

Defined in: packages/client/src/events/event-builder.ts:17

Implementation of

Brick.[BRICK]

Methods

build()

build(): EventDefinition;

Defined in: packages/client/src/events/event-builder.ts:40

Returns

EventDefinition

Implementation of

Brick.build


setEvent()

setEvent<E2>(event): EventBuilder<E2>;

Defined in: packages/client/src/events/event-builder.ts:23

Type Parameters

E2

E2 extends string

Parameters

event

E2

A Client event name

Returns

EventBuilder<E2>


setHandler()

setHandler(handler): this;

Defined in: packages/client/src/events/event-builder.ts:35

Parameters

handler

(client, ...args) => unknown

Receives the client and the event arguments

Returns

this


setOnce()

setOnce(once?): this;

Defined in: packages/client/src/events/event-builder.ts:29

Parameters

once?

boolean = true

Run the handler only once. Default true

Returns

this

On this page