Skip to Content
defold-typescript libraries
megalanthusdefold-gamepush

megalanthus/defold-gamepush/gamepush.core.achievements

GamePush achievements: lists, unlocking, progress, the achievements overlay and their events.

  • GitHub: megalanthus/defold-gamepush — pinned to v1.4.1
    1. Pick a release from megalanthus/defold-gamepush releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as core_achievements from "gamepush.core.achievements"

Functions

groups_list(): Record<string, unknown>[]

The achievement groups.

Returns

  • Record<string, unknown>[]

list(): Record<string, unknown>[]

All achievements.

Returns

  • Record<string, unknown>[]

unlocked_list(): Record<string, unknown>[]

The achievements the player has unlocked.

Returns

  • Record<string, unknown>[]

unlock(parameters: Record<string, unknown>, callback?: (result: unknown) => void)

Unlocks an achievement. Raises when the table is missing.

Parameters

  • parameters: Record<string, unknown> — The achievement, for example { tag: "my_achiv" }.
  • callback?: (result: unknown) => void — Receives the unlock result.

set_progress(parameters: Record<string, unknown>, callback?: (result: unknown) => void)

Sets an achievement's progress. Raises when the table is missing.

Parameters

  • parameters: Record<string, unknown> — The achievement and its progress, for example { tag: "my_achiv", progress: 25 }.
  • callback?: (result: unknown) => void — Receives the result.

has(id_or_tag: string | number): boolean

Whether the player has an achievement.

Parameters

  • id_or_tag: string | number — The achievement's id or tag.

Returns

  • boolean

get_progress(id_or_tag: string | number): number

An achievement's progress.

Parameters

  • id_or_tag: string | number — The achievement's id or tag.

Returns

  • number

open(callback?: () => void)

Opens the achievements overlay.

Parameters

  • callback?: () => void — Called when the overlay opens.

fetch(callback?: (achievements: unknown) => void)

Fetches the achievements.

Parameters

  • callback?: (achievements: unknown) => void — Receives the achievements.

Variables

rare: { readonly COMMON: "COMMON"; readonly UNCOMMON: "UNCOMMON"; readonly RARE: "RARE"; readonly EPIC: "EPIC"; readonly LEGENDARY: "LEGENDARY"; readonly MYTHIC: "MYTHIC"; }

The achievement rarity values.

callbacks: AchievementsCallbacks

The achievement event handlers.

Types

AchievementsCallbacks

AchievementsCallbacks.unlock?: (achievement: unknown) => void

An achievement was unlocked.

AchievementsCallbacks.error_unlock?: (error: unknown) => void

Unlocking an achievement failed.

AchievementsCallbacks.progress?: (achievement: unknown) => void

An achievement's progress changed.

AchievementsCallbacks.error_progress?: (error: unknown) => void

Changing an achievement's progress failed.

AchievementsCallbacks.open?: () => void

The achievements overlay opened.

AchievementsCallbacks.close?: () => void

The achievements overlay closed.

AchievementsCallbacks.fetch?: (result: unknown) => void

The achievements were fetched.

AchievementsCallbacks.error_fetch?: (error: unknown) => void

Fetching the achievements failed.

On this page