Docs · Events

SDK

Events

Subscribe with VPlay.on(event, fn); it returns a function that unsubscribes.

EventDataWhen
pausenoneA VPlay overlay is open (leaderboard, purchase sheet, ad, exit dialog). Stop the action.
resumenoneThe overlay closed. Carry on.
mute / unmutenoneReserved for the platform's sound control.
entitlementsstring[]What the player owns changed (a purchase, signing in or out).
vcoinsnumberThe balance changed. Display only.
confighost objectThe theme, a feature switch, a limit or the tournament changed.

Ignore events you do not recognise: the platform may add more.