Class: BedrockEventSubscriptionCache
eventBeta
A cache for bedrock event subscriptions. Stores off a subscription by event key, and upon teardown unregisters all subscriptions.
Constructors
Constructor
new BedrockEventSubscriptionCache(
mEvents):BedrockEventSubscriptionCache
Beta
Parameters
mEvents
WorldAfterEvents
Returns
BedrockEventSubscriptionCache
Remarks
Constructs a new instance of the
BedrockEventSubscriptionCache class
Methods
subscribeToBedrockEvent()
subscribeToBedrockEvent<
T>(event, ...params):any
Beta
Type Parameters
T
T extends string | number | symbol
Parameters
event
T
The event on the bedrock APIs to which to subscribe
params
...unknown[]
The parameters to the subscription method for the event. Auto complete will display this for you
Returns
any
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()
teardown():
void
Beta
Returns
void
Remarks
Cleans up the set of internal registrations and subscriptions.
