megalanthusdefold-gamepush
megalanthus/defold-gamepush/gamepush.core.uniques
GamePush unique values: register, check, read and delete values unique across players.
- GitHub: megalanthus/defold-gamepush — pinned to
v1.4.1- Pick a release from megalanthus/defold-gamepush releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as core_uniques from "gamepush.core.uniques"
- Pick a release from megalanthus/defold-gamepush releases and add its Source code (zip) URL (or a packaged
Functions
list(): Record<string, unknown>[]get(tag: string): string | undefinedregister(parameters: Record<string, unknown>, callback?: (result: unknown) => void)check(parameters: Record<string, unknown>, callback?: (result: unknown) => void)delete(parameters: Record<string, unknown>, callback?: (result: unknown) => void)
list(): Record<string, unknown>[]
The player's unique values, an empty list when it has none.
Returns
Record<string, unknown>[]
get(tag: string): string | undefined
The value registered under tag, or nil. Raises unless tag is a string.
Parameters
tag:string
Returns
string | undefined
register(parameters: Record<string, unknown>, callback?: (result: unknown) => void)
Registers or updates a unique value. Raises when the table is missing.
Parameters
parameters:Record<string, unknown>— The tag and value, for example{ tag: "login", value: "defold_player_demo" }.callback?:(result: unknown) => void— Receives the result.
check(parameters: Record<string, unknown>, callback?: (result: unknown) => void)
Checks whether a unique value is free. Raises when the table is missing.
Parameters
parameters:Record<string, unknown>— The tag and value, for example{ tag: "login", value: "defold_player_demo" }.callback?:(result: unknown) => void— Receives the result.
delete(parameters: Record<string, unknown>, callback?: (result: unknown) => void)
Deletes a unique value. Raises when the table is missing.
Parameters
parameters:Record<string, unknown>— The tag, for example{ tag: "login" }.callback?:(result: unknown) => void— Receives the result.
Variables
callbacks: UniquesCallbacks
The unique value event handlers.
Types
UniquesCallbacks
UniquesCallbacks.register?: (result: unknown) => void
A unique value was registered.
UniquesCallbacks.error_register?: (error: unknown) => void
Registering a unique value failed.
UniquesCallbacks.check?: (result: unknown) => void
A unique value was checked.
UniquesCallbacks.error_check?: (error: unknown) => void
Checking a unique value failed.
UniquesCallbacks.delete?: (result: unknown) => void
A unique value was deleted.
UniquesCallbacks.error_delete?: (error: unknown) => void
Deleting a unique value failed.