StaticAchievement

StaticAchievement

class

Achievement progress record

  • load-only Usable only while mods load. The game seals these members once loading finishes, so a call or a write from a running world raises an error.

Fields

NameTypeDescription
delta integer Progress added by the last increment
total integer Accumulated progress
threshold integer Progress required to unlock
unlocked boolean Whether the achievement is unlocked
unlocked_time number Game time of the unlock
image Texture2D Achievement icon
steam_key string Steam achievement id
label Loc Localized name
description Loc Localized description
Standard members (5)

Every class of this kind carries these.

StaticAchievement.cast(object) Trying to cast Object into StaticAchievement
StaticAchievement.get_class() Return StaticAchievement class object
StaticAchievement.find(name) Looks StaticAchievement up in db, nil when there is none
StaticAchievement.get(name) Takes StaticAchievement from db, reports a miss to the log
StaticAchievement.reg(name) load-only Register a new StaticAchievement static object
Inherited from Prototype (2)
Inherited from Object (1)