Achievements

Declare your achievements first: open My games, pick your game, and go to its Achievements tab — giving each a key, a name and an emoji. Then unlock them by key from your game. Keys you haven't declared are ignored, so a typo fails quietly rather than creating junk.

TipTap.unlockAchievement(key: string)

Unlock one of the achievement keys you declared for your game. Safe to call every frame: only a player's FIRST unlock counts, so repeat calls are ignored and the player sees exactly one notification. Unknown keys are ignored.

Example

if (kills === 1) TipTap.unlockAchievement("first_blood");
// declare the key first in Creator Studio → My games → ⋯ → Achievements

TipTap.setAchievementProgress(key, current, target)

Shows '3/5' on the locked achievement in the results overlay, turning a padlock into a reason for another run. Describes the current run and is not stored. It does not unlock anything — keep calling unlockAchievement(key) for that.

Example

TipTap.setAchievementProgress("marathon", lapsThisRun, 5);
if (lapsThisRun >= 5) TipTap.unlockAchievement("marathon");

TipTap.onAchievement(callback)

Fires only on a genuine first unlock, with { key, name, description, icon }. Use it for your own in-game celebration on top of the platform's toast.