Class BedrockEventSubscriptionCache

A cache for bedrock event subscriptions. Stores off a subscription by event key, and upon teardown unregisters all subscriptions.

Hierarchy

  • BedrockEventSubscriptionCache

Constructors

constructor

Methods

subscribeToBedrockEvent teardown

Constructors

constructor

Methods

subscribeToBedrockEvent

  • Type Parameters

    • T extends keyof WorldAfterEvents

    Parameters

    • event: T

      The event on the bedrock APIs to which to subscribe

    • Rest ...params: Parameters<WorldAfterEvents[T]["subscribe"]>

      The parameters to the subscription method for the event. Auto complete will display this for you

    Returns ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void) | ((arg) => void)

    Remarks

    Subcribes to a bedrock event using the key of the desired event. When subscribed, the event handler is both returned, but also cached internally for unsubscription. This means the caller of the subscription does not need to worry about unsubscription since the cache will automatically unsubscribe handlers on overall teardown.

teardown

  • Returns void

Settings

Member Visibility

Theme

On This Page