AchievementsAPI
此内容尚不支持你的语言。
Defined in: services/achievements.ts:89
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AchievementsAPI():
AchievementsAPI
Returns
Section titled “Returns”AchievementsAPI
Accessors
Section titled “Accessors”available
Section titled “available”Get Signature
Section titled “Get Signature”get available():
boolean
Defined in: services/achievements.ts:96
Whether a STORE is behind this. False still records unlocks — it means the platform will not draw its own notification, so a game that wants one should draw it.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”getStat()
Section titled “getStat()”getStat(
name):number
Defined in: services/achievements.ts:134
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
reset()
Section titled “reset()”reset():
Promise<void>
Defined in: services/achievements.ts:144
Development only: clear everything.
Returns
Section titled “Returns”Promise<void>
setKnown()
Section titled “setKnown()”setKnown(
ids):void
Defined in: services/achievements.ts:102
The ids this game declares, from the project’s packaging settings. Absent ⇒ nothing is checked, which is what an older project gets.
Parameters
Section titled “Parameters”readonly string[] | null
Returns
Section titled “Returns”void
setProvider()
Section titled “setProvider()”setProvider(
provider):void
Defined in: services/achievements.ts:108
Install (or restore the local default with null) the provider that answers for this platform.
Parameters
Section titled “Parameters”provider
Section titled “provider”AchievementProvider | null
Returns
Section titled “Returns”void
setStat()
Section titled “setStat()”setStat(
name,value):void
Defined in: services/achievements.ts:130
Set a stat a store may track (and may unlock an achievement from).
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”void
store()
Section titled “store()”store():
Promise<void>
Defined in: services/achievements.ts:139
Push what has been set. Cheap to call often; stores batch behind it.
Returns
Section titled “Returns”Promise<void>
unlock()
Section titled “unlock()”unlock(
id):Promise<void>
Defined in: services/achievements.ts:119
Unlock
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
id. Idempotent: re-unlocking is what a game does every time it re-checks a condition, and no store treats it as an event.
An id outside the declared set is REFUSED, not forwarded — a store would accept it and do nothing.
unlocked()
Section titled “unlocked()”unlocked(
id):boolean
Defined in: services/achievements.ts:125
Whether
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
id is unlocked, as the platform currently reports it.