Class BedrockEventSubscriptionCache

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

Index

Constructors

Methods

subscribeToBedrockEvent teardown

Constructors

constructor

new BedrockEventSubscriptionCache(
mEvents: WorldAfterEvents,
): BedrockEventSubscriptionCache
Parameters
- mEvents: WorldAfterEvents
Returns BedrockEventSubscriptionCache
Remarks
Constructs a new instance of the BedrockEventSubscriptionCache class

Methods

subscribeToBedrockEvent

subscribeToBedrockEvent<T extends keyof WorldAfterEvents>(
event: T,
...params: Parameters<WorldAfterEvents[T]["subscribe"]>,
): ReturnType<WorldAfterEvents[T]["subscribe"]>
Type Parameters
- T extends keyof WorldAfterEvents
Parameters
- event: T
  The event on the bedrock APIs to which to subscribe
- ...params: Parameters<WorldAfterEvents[T]["subscribe"]>
  The parameters to the subscription method for the event. Auto complete will display this for you
Returns ReturnType<WorldAfterEvents[T]["subscribe"]>
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.

World Ready
This function can't be called in early-execution mode.

teardown

teardown(): void
Returns void
Remarks
Cleans up the set of internal registrations and subscriptions.

World Ready
This function can't be called in early-execution mode.