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

Class DurationAbilityWithCost2

java.lang.Object

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

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

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

Direct Known Subclasses:

GenerateSlipsurgeAbility

public class DurationAbilityWithCost2
extends BaseDurationAbility

Field Summary

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

activeDaysLeft, cooldownLeft, fadingOut, level, LOOP_FADE_TIME_DAYS, loopFadeLeft, 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
DurationAbilityWithCost2()

Method Summary

Modifier and Type	Method and Description
protected void	activateImpl()
void	addInitialDescription(TooltipMakerAPI tooltip, boolean expanded)
void	addNotUsableReasonAfterFuelCost(TooltipMakerAPI tooltip, boolean expanded)
boolean	addNotUsableReasonBeforeFuelCost(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()
protected void	cleanupImpl()
protected float	computeFuelCost()
protected float	computeSupplyCost()
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded) Will be called every frame the tooltip is shown, so the tooltip can be dynamic.
protected void	deactivateImpl()
protected void	deductCost()
void	fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	fleetOpenedMarket(MarketAPI market) Only called for the player fleet.
float	getActivationAtLowCRShipDamageProbability()
Misc.FleetMemberDamageLevel	getActivationDamageLevel()
java.awt.Color	getCooldownColor()
float	getCooldownFraction() 0 at start of cooldown, 1 at end.
float	getCRCost(FleetMemberAPI member)
float	getCRCostMult()
float	getFuelCostMult()
protected java.util.List<FleetMemberAPI>	getNonReadyShips()
boolean	hasTooltip()
boolean	isCooldownRenderingAdditive()
boolean	isOnCooldown()
boolean	isUsable() Whether the ability can be activated / the UI button corresponding to it is enabled.
protected boolean	showAlarm()
protected void	unapplyStatsEffect()

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

activate, addIncompatibleToTooltip, advance, cleanup, deactivate, getActivationDays, getActiveDaysLeft, getCooldownDays, getCooldownLeft, getDeactivationDays, getDurationDays, getLevel, getLoopSoundUIPitch, getLoopSoundUIVolume, getLoopSoundWorldPitch, getLoopSoundWorldVolume, getProgressFraction, getTotalDurationDays, hasCustomButtonPressSounds, isActive, isFadingOut, isInProgress, pressButton, runWhilePaused, setActiveDaysLeft, setCooldownLeft, showActiveIndicator, showProgressIndicator

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

addIncompatibleToTooltip, disableIncompatible, fleetJoinedBattle, 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, isTooltipExpandable, readResolve, render, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Constructor Detail

DurationAbilityWithCost2

public DurationAbilityWithCost2()

Method Detail

getFuelCostMult

public float getFuelCostMult()

getCRCostMult

public float getCRCostMult()

getActivationAtLowCRShipDamageProbability

public float getActivationAtLowCRShipDamageProbability()

getActivationDamageLevel

public Misc.FleetMemberDamageLevel getActivationDamageLevel()

canRecoverCRWhileActive

public boolean canRecoverCRWhileActive()

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: BaseDurationAbility

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

Specified by:

applyEffect in class BaseDurationAbility

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseDurationAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl in class BaseDurationAbility

getNonReadyShips

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

getCRCost

public float getCRCost(FleetMemberAPI member)

computeFuelCost

protected float computeFuelCost()

computeSupplyCost

protected float computeSupplyCost()

addInitialDescription

public void addInitialDescription(TooltipMakerAPI tooltip,
                                  boolean expanded)

addNotUsableReasonBeforeFuelCost

public boolean addNotUsableReasonBeforeFuelCost(TooltipMakerAPI tooltip,
                                                boolean expanded)

addNotUsableReasonAfterFuelCost

public void addNotUsableReasonAfterFuelCost(TooltipMakerAPI tooltip,
                                            boolean expanded)

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Description copied from interface: AbilityPlugin

Will be called every frame the tooltip is shown, so the tooltip can be dynamic.

Specified by:

createTooltip in interface AbilityPlugin

Overrides:

createTooltip in class BaseAbilityPlugin

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface AbilityPlugin

Overrides:

hasTooltip in class BaseAbilityPlugin

fleetLeftBattle

public void fleetLeftBattle(BattleAPI battle,
                            boolean engagedInHostilities)

Specified by:

fleetLeftBattle in interface AbilityPlugin

Overrides:

fleetLeftBattle in class BaseAbilityPlugin

fleetOpenedMarket

public void fleetOpenedMarket(MarketAPI market)

Description copied from interface: AbilityPlugin

Only called for the player fleet.

Specified by:

fleetOpenedMarket in interface AbilityPlugin

Overrides:

fleetOpenedMarket in class BaseAbilityPlugin

showAlarm

protected boolean showAlarm()

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 BaseDurationAbility

Returns:

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 BaseDurationAbility

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

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseDurationAbility