megalanthus/defold-gamepush/gamepush.core.schedulers
GamePush reward schedulers: daily rewards, extra-activity rewards and their claim checks, with their events.
- 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_schedulers from "gamepush.core.schedulers"
- Pick a release from megalanthus/defold-gamepush releases and add its Source code (zip) URL (or a packaged
Functions
claim_day(id_or_tag: string | number, day: number, callback?: (result: unknown) => void)claim_day_additional(id_or_tag: string | number, day: number, trigger_id_or_tag: string, callback?: (result: unknown) => void)claim_all_day(id_or_tag: string | number, day: number, callback?: (result: unknown) => void)claim_all_days(id_or_tag: string | number, callback?: (result: unknown) => void)list(): Record<string, unknown>[]active_list(): Record<string, unknown>[]get_scheduler(id_or_tag: string | number): Record<string, unknown>get_scheduler_day(id_or_tag: string | number, day: number): Record<string, unknown>get_scheduler_current_day(id_or_tag: string | number): Record<string, unknown>is_registered(id_or_tag: string | number): booleanis_today_reward_claimed(id_or_tag: string | number): booleancan_claim_day(id_or_tag: string | number, day: number): booleancan_claim_day_additional(id_or_tag: string | number, day: number, trigger_id_or_tag: string): booleancan_claim_all_day(id_or_tag: string | number, day: number): boolean
claim_day(id_or_tag: string | number, day: number, callback?: (result: unknown) => void)
Claims a day's reward. Raises unless day is a number.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.callback?:(result: unknown) => void— Receives the result.
claim_day_additional(id_or_tag: string | number, day: number, trigger_id_or_tag: string, callback?: (result: unknown) => void)
Claims a day's reward for an extra activity. Raises unless day is a number and
trigger_id_or_tag a string.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.trigger_id_or_tag:string— The activity trigger's id or tag.callback?:(result: unknown) => void— Receives the result.
claim_all_day(id_or_tag: string | number, day: number, callback?: (result: unknown) => void)
Claims a day's reward for every activity. Raises unless day is a number.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.callback?:(result: unknown) => void— Receives the result.
claim_all_days(id_or_tag: string | number, callback?: (result: unknown) => void)
Claims the rewards for every completed day.
Parameters
id_or_tag:string | number— The scheduler's id or tag.callback?:(result: unknown) => void— Receives the result.
list(): Record<string, unknown>[]
All schedulers.
Returns
Record<string, unknown>[]
active_list(): Record<string, unknown>[]
The schedulers the player is taking part in.
Returns
Record<string, unknown>[]
get_scheduler(id_or_tag: string | number): Record<string, unknown>
A scheduler's description.
Parameters
id_or_tag:string | number— The scheduler's id or tag.
Returns
Record<string, unknown>
get_scheduler_day(id_or_tag: string | number, day: number): Record<string, unknown>
A scheduler day's description. Raises unless day is a number.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.
Returns
Record<string, unknown>
get_scheduler_current_day(id_or_tag: string | number): Record<string, unknown>
The description of a scheduler's current day.
Parameters
id_or_tag:string | number— The scheduler's id or tag.
Returns
Record<string, unknown>
is_registered(id_or_tag: string | number): boolean
Whether the player is taking part in a scheduler.
Parameters
id_or_tag:string | number— The scheduler's id or tag.
Returns
boolean
is_today_reward_claimed(id_or_tag: string | number): boolean
Whether today's reward was claimed.
Parameters
id_or_tag:string | number— The scheduler's id or tag.
Returns
boolean
can_claim_day(id_or_tag: string | number, day: number): boolean
Whether a day's reward can be claimed. Raises unless day is a number.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.
Returns
boolean
can_claim_day_additional(id_or_tag: string | number, day: number, trigger_id_or_tag: string): boolean
Whether a day's reward for an extra activity can be claimed. Raises unless day is a
number and trigger_id_or_tag a string.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.trigger_id_or_tag:string— The activity trigger's id or tag.
Returns
boolean
can_claim_all_day(id_or_tag: string | number, day: number): boolean
Whether a day's reward for every activity can be claimed. Raises unless day is a
number.
Parameters
id_or_tag:string | number— The scheduler's id or tag.day:number— The day.
Returns
boolean
Variables
callbacks: SchedulersCallbacks
The scheduler event handlers.
Types
SchedulersCallbacks
SchedulersCallbacks.claim_day?: (scheduler: unknown) => void
A day's reward was claimed.
SchedulersCallbacks.error_claim_day?: (error: unknown) => void
Claiming a day's reward failed.
SchedulersCallbacks.claim_day_additional?: (scheduler: unknown) => void
A day's reward for an extra activity was claimed.
SchedulersCallbacks.error_claim_day_additional?: (error: unknown) => void
Claiming a day's reward for an extra activity failed.
SchedulersCallbacks.claim_all_day?: (scheduler: unknown) => void
A day's reward for every activity was claimed.
SchedulersCallbacks.error_claim_all_day?: (error: unknown) => void
Claiming a day's reward for every activity failed.
SchedulersCallbacks.claim_all_days?: (scheduler: unknown) => void
The rewards for every completed day were claimed.
SchedulersCallbacks.error_claim_all_days?: (error: unknown) => void
Claiming the rewards for every completed day failed.
SchedulersCallbacks.join?: (scheduler: unknown) => void
The player joined a scheduler.
SchedulersCallbacks.error_join?: (error: unknown) => void
Joining a scheduler failed.