com.fs.starfarer.api.impl.campaign.abilities

Class ToggleAbilityWithCost

java.lang.Object

com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin

com.fs.starfarer.api.impl.campaign.abilities.BaseToggleAbility

com.fs.starfarer.api.impl.campaign.abilities.ToggleAbilityWithCost

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

Direct Known Subclasses:

ReversePolarityToggle

public class ToggleAbilityWithCost
extends BaseToggleAbility

Field Summary

Fields inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseToggleAbility

cooldownLeft, isActivateCooldown, level, turnedOn

Fields inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin

disableFrames, entity, id, PLAY_UI_SOUNDS_IN_WORLD_SOURCES, spec

Constructor Summary

Constructors

Constructor and Description
ToggleAbilityWithCost()

Method Summary

Modifier and Type	Method and Description
protected void	activateImpl()
void	addCostTooltipSection(TooltipMakerAPI tooltip, boolean expanded, java.lang.String prefix)
void	addOtherNotUsableReason(TooltipMakerAPI tooltip, boolean expanded)
protected void	applyEffect(float amount, float level) Will be called once when level is 0 and consistently when level >0.
protected void	applyFleetVisual(float amount, float level)
protected void	applyStatsEffect(float amount, float level)
boolean	canRecoverCRWhileActive(boolean forTooltip)
protected void	cleanupImpl()
protected float	computeFuelCost(boolean forTooltip)
protected float	computeSupplyCost(boolean forTooltip)
protected void	deactivateImpl()
protected void	deductCost()
float	getActivationAtLowCRShipDamageProbability(boolean forTooltip)
Misc.FleetMemberDamageLevel	getActivationDamageLevel(boolean forTooltip)
java.awt.Color	getCooldownColor()
float	getCooldownFraction() 0 at start of cooldown, 1 at end.
float	getCRCost(FleetMemberAPI member, boolean forTooltip)
float	getCRCostMult(boolean forTooltip)
float	getFuelCostMult(boolean forTooltip)
protected java.util.List<FleetMemberAPI>	getNonReadyShips(boolean forTooltip)
boolean	hasTooltip()
boolean	isCooldownRenderingAdditive()
boolean	isOnCooldown()
boolean	isUsable() Whether the ability can be activated / the UI button corresponding to it is enabled.
boolean	shouldApplyCostWhenDeactivating(boolean forTooltip)
protected boolean	showAlarm()
protected void	unapplyStatsEffect()

Methods inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseToggleAbility

activate, addIncompatibleToTooltip, advance, cleanup, deactivate, getActivateCooldownDays, getActivationDays, getCooldownLeft, getDeactivateCooldownDays, getDeactivationDays, getLevel, getLoopSoundUIPitch, getLoopSoundUIVolume, getLoopSoundWorldPitch, getLoopSoundWorldVolume, getProgressFraction, hasCustomButtonPressSounds, isActive, pressButton, runWhilePaused, setCooldownLeft, showActiveIndicator, showProgressIndicator

Methods inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin

addIncompatibleToTooltip, createTooltip, disableIncompatible, fleetJoinedBattle, fleetLeftBattle, fleetOpenedMarket, forceDisable, getActivationText, getActiveColor, getActiveLayers, getDeactivationText, getEntity, getFleet, getId, getInterruptedList, getLoopSoundUI, getLoopSoundWorld, getModId, getOffSoundUI, getOffSoundWorld, getOnSoundUI, getOnSoundWorld, getProgressColor, getSpec, getSpriteName, getTooltipWidth, init, interruptIncompatible, isActiveOrInProgress, isCompatible, isDone, isInProgress, isTooltipExpandable, readResolve, render, showCooldownIndicator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToggleAbilityWithCost

public ToggleAbilityWithCost()

Method Detail

getFuelCostMult

public float getFuelCostMult(boolean forTooltip)

getCRCostMult

public float getCRCostMult(boolean forTooltip)

getActivationAtLowCRShipDamageProbability

public float getActivationAtLowCRShipDamageProbability(boolean forTooltip)

getActivationDamageLevel

public Misc.FleetMemberDamageLevel getActivationDamageLevel(boolean forTooltip)

canRecoverCRWhileActive

public boolean canRecoverCRWhileActive(boolean forTooltip)

shouldApplyCostWhenDeactivating

public boolean shouldApplyCostWhenDeactivating(boolean forTooltip)

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseToggleAbility

deductCost

protected void deductCost()

applyStatsEffect

protected void applyStatsEffect(float amount,
                                float level)

unapplyStatsEffect

protected void unapplyStatsEffect()

applyFleetVisual

protected void applyFleetVisual(float amount,
                                float level)

applyEffect

protected void applyEffect(float amount,
                           float level)

Description copied from class: BaseToggleAbility

Will be called once when level is 0 and consistently when level >0.

Specified by:

applyEffect in class BaseToggleAbility

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseToggleAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl in class BaseToggleAbility

getNonReadyShips

protected java.util.List<FleetMemberAPI> getNonReadyShips(boolean forTooltip)

getCRCost

public float getCRCost(FleetMemberAPI member,
                       boolean forTooltip)

computeFuelCost

protected float computeFuelCost(boolean forTooltip)

computeSupplyCost

protected float computeSupplyCost(boolean forTooltip)

addOtherNotUsableReason

public void addOtherNotUsableReason(TooltipMakerAPI tooltip,
                                    boolean expanded)

addCostTooltipSection

public void addCostTooltipSection(TooltipMakerAPI tooltip,
                                  boolean expanded,
                                  java.lang.String prefix)

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface AbilityPlugin

Overrides:

hasTooltip in class BaseAbilityPlugin

isOnCooldown

public boolean isOnCooldown()

Specified by:

isOnCooldown in interface AbilityPlugin

Overrides:

isOnCooldown in class BaseAbilityPlugin

isUsable

public boolean isUsable()

Description copied from interface: AbilityPlugin

Whether the ability can be activated / the UI button corresponding to it is enabled.

Specified by:

isUsable in interface AbilityPlugin

Overrides:

isUsable in class BaseToggleAbility

Returns:

showAlarm

protected boolean showAlarm()

getCooldownFraction

public float getCooldownFraction()

Description copied from interface: AbilityPlugin

0 at start of cooldown, 1 at end.

Specified by:

getCooldownFraction in interface AbilityPlugin

Overrides:

getCooldownFraction in class BaseToggleAbility

Returns:

getCooldownColor

public java.awt.Color getCooldownColor()

Specified by:

getCooldownColor in interface AbilityPlugin

Overrides:

getCooldownColor in class BaseAbilityPlugin

isCooldownRenderingAdditive

public boolean isCooldownRenderingAdditive()

Specified by:

isCooldownRenderingAdditive in interface AbilityPlugin

Overrides:

isCooldownRenderingAdditive in class BaseAbilityPlugin