Type Alias ItemEvents

An interface with all supported item/hint events and their respective callback arguments. To be called from ItemsManager.

type ItemEvents = {
    hintFound: [hint: Hint];
    hintReceived: [hint: Hint];
    hintsInitialized: [hints: Hint[]];
    hintUpdated: [hint: Hint];
    itemsReceived: [items: Item[], startingIndex: number];
}
Index
hintFound hintReceived hintsInitialized hintUpdated itemsReceived
hintFound: [hint: Hint]

Fired when a hint has been found.

The hint that has been found.

hintReceived: [hint: Hint]

Fired when a new hint has been received.

The hint that has been created.

hintsInitialized: [hints: Hint[]]

Fired shortly after initial connection with all current hints relevant to this player.

All hints ever created relevant to this player.

hintUpdated: [hint: Hint]

Fired when a hint has been updated.

The hint that has been updated.

itemsReceived: [items: Item[], startingIndex: number]

Fired when items have been received.

An array of item metadata in the order they are sent.

The ItemsManager.received index for the first item in the items array.

Settings
Member Visibility

On This Page
Properties