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

Class ReversePolarityToggle

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

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class ReversePolarityToggle
extends ToggleAbilityWithCost

Field Summary

Fields

Modifier and Type	Field	Description
static float	ACTIVATION_DAMAGE_PROB
static float	CR_COST_MULT
static float	FUEL_COST_MULT
static String	POLARITY_SPEED_MULT
static Color	POLARITY_WIND_GLOW_COLOR
static String	POLARITY_WIND_GLOW_COLOR_KEY
static String	REVERSED_POLARITY
static float	SLIPSTREAM_SPEED_MULT

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	Description
ReversePolarityToggle()

Method Summary

Modifier and Type	Method	Description
void	addOtherNotUsableReason(TooltipMakerAPI tooltip, boolean expanded)
protected void	applyFleetVisual(float amount, float level)
protected void	applyStatsEffect(float amount, float level)
boolean	canRecoverCRWhileActive(boolean forTooltip)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)	Will be called every frame the tooltip is shown, so the tooltip can be dynamic.
protected String	getActivationText()
Color	getCooldownColor()
float	getCRCostMult(boolean forTooltip)
float	getFuelCostMult(boolean forTooltip)
boolean	isFleetInSlipstream()
boolean	isUsable()	Whether the ability can be activated / the UI button corresponding to it is enabled.
protected boolean	showAlarm()

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

activateImpl, addCostTooltipSection, applyEffect, cleanupImpl, computeFuelCost, computeSupplyCost, deactivateImpl, deductCost, getActivationAtLowCRShipDamageProbability, getActivationDamageLevel, getCooldownFraction, getCRCost, getNonReadyShips, hasTooltip, isCooldownRenderingAdditive, isOnCooldown, shouldApplyCostWhenDeactivating, 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, disableIncompatible, fleetJoinedBattle, fleetLeftBattle, fleetOpenedMarket, forceDisable, 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

Field Details

REVERSED_POLARITY

public static String REVERSED_POLARITY

POLARITY_SPEED_MULT

public static String POLARITY_SPEED_MULT

POLARITY_WIND_GLOW_COLOR_KEY

public static String POLARITY_WIND_GLOW_COLOR_KEY

POLARITY_WIND_GLOW_COLOR

public static Color POLARITY_WIND_GLOW_COLOR

SLIPSTREAM_SPEED_MULT

public static float SLIPSTREAM_SPEED_MULT

CR_COST_MULT

public static float CR_COST_MULT

FUEL_COST_MULT

public static float FUEL_COST_MULT

ACTIVATION_DAMAGE_PROB

public static float ACTIVATION_DAMAGE_PROB

Constructor Details

ReversePolarityToggle

public ReversePolarityToggle()

Method Details

getFuelCostMult

public float getFuelCostMult(boolean forTooltip)

Overrides:

getFuelCostMult in class ToggleAbilityWithCost

getCRCostMult

public float getCRCostMult(boolean forTooltip)

Overrides:

getCRCostMult in class ToggleAbilityWithCost

canRecoverCRWhileActive

public boolean canRecoverCRWhileActive(boolean forTooltip)

Overrides:

canRecoverCRWhileActive in class ToggleAbilityWithCost

getActivationText

protected String getActivationText()

Overrides:

getActivationText 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 ToggleAbilityWithCost

Returns:

applyStatsEffect

protected void applyStatsEffect(float amount,
 float level)

Overrides:

applyStatsEffect in class ToggleAbilityWithCost

applyFleetVisual

protected void applyFleetVisual(float amount,
 float level)

Overrides:

applyFleetVisual in class ToggleAbilityWithCost

isFleetInSlipstream

public boolean isFleetInSlipstream()

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

addOtherNotUsableReason

public void addOtherNotUsableReason(TooltipMakerAPI tooltip,
 boolean expanded)

Overrides:

addOtherNotUsableReason in class ToggleAbilityWithCost

showAlarm

protected boolean showAlarm()

Overrides:

showAlarm in class ToggleAbilityWithCost

getCooldownColor

public Color getCooldownColor()

Specified by:

getCooldownColor in interface AbilityPlugin

Overrides:

getCooldownColor in class ToggleAbilityWithCost