root/org.magiclib.achievements/MagicAchievement

MagicAchievement

The base class for all achievements. Extend this class to create your own.

First, create an entry in your data/config/magic_achievements.csv file. Set the script column to this class's package and name.

This class is not serialized to the save file.

Author

Wisp

Constructors

MagicAchievement

constructor()

Do not use this constructor.

Types

VisualEffectData

open class VisualEffectData

Functions

advanceAfterInterval

open fun advanceAfterInterval(amount: Float)

Like regular advance, but NOT CALLED EVERY FRAME.

advanceInCombat

open fun advanceInCombat(amount: Float, events: List<InputEventAPI>, isSimulation: Boolean)

Called every frame during combat.

afterGameSave

open fun afterGameSave()

Called each time the game is loaded.

beforeGameSave

open fun beforeGameSave()

Called each time the game is saved.

completeAchievement

open fun completeAchievement()

open fun completeAchievement(completedByPlayer: PersonAPI)

open fun completeAchievement(completedByPlayer: PersonAPI, textPanel: TextPanelAPI)

Call when the achievement is completed.

createTooltip

open fun createTooltip(tooltipMakerAPI: TooltipMakerAPI, isExpanded: Boolean, width: Float)

Allows full control of the tooltip.

createTooltipHeader

open fun createTooltipHeader(tooltipMakerAPI: TooltipMakerAPI)

getAchievementMemory

open fun getAchievementMemory(): Map<String, Any>

A map for storing arbitrary data.

getAdvanceIntervalUtil

open fun getAdvanceIntervalUtil(): IntervalUtil

Returns the time interval in seconds between each call to advanceAfterInterval.

getDescription

open fun getDescription(): String

getHasProgressBar

open fun getHasProgressBar(): Boolean

Whether or not to show a progress bar for this achievement.

getImage

open fun getImage(): String

getModId

open fun getModId(): String

getModName

open fun getModName(): String

getName

open fun getName(): String

getRarity

open fun getRarity(): MagicAchievementRarity

getScript

open fun getScript(): String

getSoundEffectId

open fun getSoundEffectId(): String

Defined in sounds.json.

getSpecId

open fun getSpecId(): String

getSpoilerLevel

open fun getSpoilerLevel(): MagicAchievementSpoilerLevel

getTooltip

open fun getTooltip(): String

getVisualEffectData

open fun getVisualEffectData(): MagicAchievement.VisualEffectData

Returns the color of the particle effect for this achievement's rarity.

hasTooltip

open fun hasTooltip(): Boolean

isComplete

open fun isComplete(): Boolean

loadFromJsonObject

open fun loadFromJsonObject(jsonObject: JSONObject): Boolean

Sets this achievement's data from the given JSON object.

onApplicationLoaded

open fun onApplicationLoaded(isComplete: Boolean)

Called when Starsector is loaded.

onCompleted

open fun onCompleted(completedByPlayer: PersonAPI)

onDestroyed

open fun onDestroyed()

Do any cleanup logic here, e.g.

onSaveGameLoaded

open fun onSaveGameLoaded(isComplete: Boolean)

Called each time the achievement is loaded, for example when the game is loaded.

saveChanges

open fun saveChanges()

Call this to save any changes to the achievement (and all others as well).

setAdvanceIntervalUtil

open fun setAdvanceIntervalUtil(interval: IntervalUtil)

Sets the time interval between each call to advanceAfterInterval.

setDescription

open fun setDescription(description: String)

setHasProgressBar

open fun setHasProgressBar(hasProgressBar: Boolean)

setImage

open fun setImage(image: String)

setName

open fun setName(name: String)

setRarity

open fun setRarity(rarity: MagicAchievementRarity)

setScript

open fun setScript(script: String)

setSpoilerLevel

open fun setSpoilerLevel(spoilerLevel: MagicAchievementSpoilerLevel)

setTooltip

open fun setTooltip(tooltip: String)

shouldShowInIntel

open fun shouldShowInIntel(): Boolean

Whether or not to show this achievement in the Intel screen.

toJsonObject

open fun toJsonObject(): JSONObject

Serializes this achievement to a JSON object.

uncompleteAchievement

open fun uncompleteAchievement(clearMemory: Boolean)

Don't use this except for very good reasons, e.g.

Properties

completedByUserId

open var completedByUserId: String

completedByUserName

open var completedByUserName: String

dateCompleted

open var dateCompleted: Date

errorMessage

open var errorMessage: String

Shown if set.

maxProgress

open var maxProgress: Float

memory

val memory: Map<String, Any>

progress

open var progress: Float