root/org.magiclib.achievements/MagicAchievementManager

MagicAchievementManager

open class MagicAchievementManager

Manages and tracks achievements.

An achievement is made from a spec, which is used to create the achievement class with the code to detect the achievement conditions.

To add an achievement, add it to the magic_achievements.csv file in your mod's data/config folder. Alternatively, call addAchievementSpecs in your mod plugin's onGameLoad() method.

Then, create a class that extends MagicAchievement and implement the detection logic. You will need to call setComplete() and then saveChanges() to complete the achievement.

Constructors

MagicAchievementManager

constructor()

Functions

addAchievementSpecs

open fun addAchievementSpecs(specs: Array<MagicAchievementSpec>)

Use this to create achievements that are not defined in magic_achievements.csv.

open fun afterGameSave()

Calls all achievements' afterGameSave() method.

areAchievementsEnabled

open fun areAchievementsEnabled(): Boolean

open fun beforeGameSave()

Calls all achievements' beforeGameSave() method.

completeAchievement

open fun completeAchievement(achievementClass: Class<out MagicAchievement>)

open fun completeAchievement(specId: String)

generateAchievementsFromSpec

open fun generateAchievementsFromSpec(specs: Map<String, MagicAchievementSpec>): Map<String, MagicAchievement>

Creates achievements from the given specs, creates the script instances from the class name, and returns them.

open fun getAchievement(specId: String): MagicAchievement

open fun getIntel(): MagicAchievementIntel

getSpecsFromFiles

open fun getSpecsFromFiles(): Map<String, MagicAchievementSpec>

Reads achievement specs from CSV files in mods and returns them.

open fun initIntel()

onApplicationLoad

open fun onApplicationLoad()

Loads achievements (so that any that track stuff outside the campaign are started).

open fun onGameLoad()

(Re)loads achievements (so that any that track stuff outside the campaign are started).

playSoundEffect

open fun playSoundEffect(achievement: MagicAchievement)

You shouldn't need to call this.

reloadAchievements

open fun reloadAchievements(isSaveGameLoaded: Boolean)

Unloads all current achievements from the sector and reloads them from files.

removeAchievementSpec

open fun removeAchievementSpec(specId: String)

resetAchievementToSpec

open fun resetAchievementToSpec(achievement: MagicAchievement)

Resets the achievement passed in to the spec.

setAchievementsEnabled

open fun setAchievementsEnabled(areAchievementsEnabled: Boolean, isSaveLoaded: Boolean)

Sets whether achievements are enabled or not.

Properties

val achievements: Map<String, MagicAchievement>

achievementScriptsWithCombatRunError

open var achievementScriptsWithCombatRunError: Set<String>

Set of achievement IDs that have thrown an error in their advanceInCombat method.

achievementScriptsWithRunError

open var achievementScriptsWithRunError: Set<String>

Set of achievement IDs that have thrown an error in their advance method.

achievementSpecs

open val achievementSpecs: Map<String, MagicAchievementSpec>

Loaded once at launch and not again.

open val instance: MagicAchievementManager