If getKey returns a non-null non-empty string, retrieves the index for its value from getKeyIndex Otherwise uses getKeyIndex to retrieve the key from the getKeyForIndex method

getBarFill

open fun getBarFill(): Float

How full the status bar will appear.

getBarLocationForBarNum

open fun getBarLocationForBarNum(baseBarLoc: Vector2f, barNum: Int): Vector2f

getBaseActiveDuration

abstract fun getBaseActiveDuration(): Float

How long the subsystem is active for.

getBaseChargeRechargeDuration

open fun getBaseChargeRechargeDuration(): Float

How long the subsystem takes to gain a charge.

getBaseCooldownDuration

abstract fun getBaseCooldownDuration(): Float

How long the subsystem is in State.COOLDOWN for.

getBaseInDuration

open fun getBaseInDuration(): Float

How long the subsystem is in State.IN for.

getBaseOutDuration

open fun getBaseOutDuration(): Float

How long the subsystem is in State.OUT for.

getBriefText

open fun getBriefText(): String

A short description of what your subsystem does.

getCharges

open fun getCharges(): Int

getDisplayText

abstract fun getDisplayText(): String

This is appended to the key used to activate the subsystem.

getEffectLevel

open fun getEffectLevel(): Float

Calculates how "effective" the system is based on its state and the time remaining in that state.

getExtraInfoColor

open fun getExtraInfoColor(): Color

Color of the text to the right of the status bar.

getExtraInfoText

open fun getExtraInfoText(): String

Some extra info that displays to the right of the status bar.

getFluxCostFlatOnActivation

open fun getFluxCostFlatOnActivation(): Float

Flux cost on activation.

getFluxCostFlatPerSecondWhileActive

open fun getFluxCostFlatPerSecondWhileActive(): Float

Flux cost while active.

getFluxCostPercentOnActivation

open fun getFluxCostPercentOnActivation(): Float

Flux cost on activation as percent of base flux capacity of the ship.

getFluxCostPercentPerSecondWhileActive

open fun getFluxCostPercentPerSecondWhileActive(): Float

Flux cost on activation as percent of base flux capacity of the ship.

getHUDColor

open fun getHUDColor(): Color

The color to display all the info about the system in

getKey

open fun getKey(): String

getKeyIndex

open fun getKeyIndex(): Int

The automatically-assigned key index when a subsystem is added to a ship.

getKeyText

open fun getKeyText(): String

The displayed key text to activate the system.

getNumHUDBars

open fun getNumHUDBars(): Int

Number of "bar heights" that the subsystem needs.

getOrder

open fun getOrder(): Int

How "important" this system is.

getState

open fun getState(): MagicSubsystem.State

getStateCompleteRatio

open fun getStateCompleteRatio(): Float

Returns ratio of how "complete" the state is.

getStateText

open fun getStateText(): String

Prints to the left of the status bar.

getSystemStatsEffectMult

open fun getSystemStatsEffectMult(): Float

How much the subsystem is affected by ship system stats like Systems Expertise.

hasCharges

open fun hasCharges(): Boolean

Base amount of charges unaffected by any stats.

isActive

open fun isActive(): Boolean

isCooldown

open fun isCooldown(): Boolean

isHardFluxForActivation

open fun isHardFluxForActivation(): Boolean

Set flux cost on activation to be hard flux.

isHardFluxPerSecondWhileActive

open fun isHardFluxPerSecondWhileActive(): Boolean

Set flux cost while active to be hard flux.

isIn

open fun isIn(): Boolean

isKeyDown

open fun isKeyDown(): Boolean

Player ship only.

isOff

open fun isOff(): Boolean

isOn

open fun isOn(): Boolean

isOut

open fun isOut(): Boolean

isReady

open fun isReady(): Boolean

isToggle

open fun isToggle(): Boolean

onActivate

open fun onActivate()

Runs when the key is pressed to activate the subsystem, or the AI activates it.

onFinished

open fun onFinished()

When state is set to COOLDOWN.

onShipDeath

open fun onShipDeath()

Called when the ship dies while system is active (IN, ACTIVE, OUT states)

onStateSwitched

open fun onStateSwitched(oldState: MagicSubsystem.State)

Called when the state is switched to something else.

renderWorld

open fun renderWorld(viewport: ViewportAPI)

Renders onto the world viewport.

requiresTarget

open fun requiresTarget(): Boolean

The subsystem will show "NO TARGET" on the HUD if no target is selected.

setCharges

open fun setCharges(charges: Int)

setKey

open fun setKey(key: String)

setKeyIndex

open fun setKeyIndex(keyIndex: Int)

setState

open fun setState(newState: MagicSubsystem.State)

Called to set the state of the system.

shouldActivateAI

abstract fun shouldActivateAI(amount: Float): Boolean

targetOnlyEnemies

open fun targetOnlyEnemies(): Boolean

The subsystem will show "NO TARGET" on the HUD if a friendly target is selected.

usesChargesOnActivate

open fun usesChargesOnActivate(): Boolean

Properties

activeDuration

open var activeDuration: Float

BLANK_KEY

open var BLANK_KEY: String

chargeGenerationDuration

open var chargeGenerationDuration: Float

cooldownDuration

open var cooldownDuration: Float

inDuration

open var inDuration: Float

outDuration

open var outDuration: Float

STATUS_FLUX_TOO_HIGH

open var STATUS_FLUX_TOO_HIGH: String

STATUS_NO_TARGET

open var STATUS_NO_TARGET: String

STATUS_OUT_OF_RANGE

open var STATUS_OUT_OF_RANGE: String