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

Class InterdictionPulseAbility

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.InterdictionPulseAbility

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class InterdictionPulseAbility
extends BaseDurationAbility

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterdictionPulseAbility.IPReactionScript

Field Summary

Fields

Modifier and Type	Field and Description
static float	BASE_RANGE
static float	BASE_SECONDS
static float	DETECTABILITY_PERCENT
protected java.lang.Float	elapsed
static float	MAX_EFFECT
protected java.lang.Integer	numFired
protected java.lang.Boolean	primed
static float	STRENGTH_PER_SECOND

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
InterdictionPulseAbility()

Method Summary

Modifier and Type	Method and Description
protected void	activateImpl()
protected void	applyEffect(float amount, float level) Will be called once when level is 0 and consistently when level >0.
protected void	cleanupImpl()
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded) Will be called every frame the tooltip is shown, so the tooltip can be dynamic.
protected void	deactivateImpl()
void	fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	fleetOpenedMarket(MarketAPI market) Only called for the player fleet.
protected java.lang.String	getActivationText()
static float	getInterdictSeconds(CampaignFleetAPI fleet, CampaignFleetAPI other)
static float	getRange(CampaignFleetAPI fleet)
boolean	hasTooltip()
boolean	isUsable() Whether the ability can be activated / the UI button corresponding to it is enabled.
protected void	showRangePing(float amount)

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

activate, addIncompatibleToTooltip, advance, cleanup, deactivate, getActivationDays, getActiveDaysLeft, getCooldownDays, getCooldownFraction, 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, getActiveColor, getActiveLayers, getCooldownColor, getDeactivationText, getEntity, getFleet, getId, getInterruptedList, getLoopSoundUI, getLoopSoundWorld, getModId, getOffSoundUI, getOffSoundWorld, getOnSoundUI, getOnSoundWorld, getProgressColor, getSpec, getSpriteName, getTooltipWidth, init, interruptIncompatible, isActiveOrInProgress, isCompatible, isCooldownRenderingAdditive, isDone, isOnCooldown, isTooltipExpandable, readResolve, render, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Field Detail

MAX_EFFECT

public static final float MAX_EFFECT

See Also:

Constant Field Values

BASE_RANGE

public static final float BASE_RANGE

See Also:

Constant Field Values

BASE_SECONDS

public static final float BASE_SECONDS

See Also:

Constant Field Values

STRENGTH_PER_SECOND

public static final float STRENGTH_PER_SECOND

See Also:

Constant Field Values

DETECTABILITY_PERCENT

public static final float DETECTABILITY_PERCENT

See Also:

Constant Field Values

primed

protected java.lang.Boolean primed

elapsed

protected java.lang.Float elapsed

numFired

protected java.lang.Integer numFired

Constructor Detail

InterdictionPulseAbility

public InterdictionPulseAbility()

Method Detail

getRange

public static float getRange(CampaignFleetAPI fleet)

getActivationText

protected java.lang.String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseDurationAbility

showRangePing

protected void showRangePing(float amount)

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

getInterdictSeconds

public static float getInterdictSeconds(CampaignFleetAPI fleet,
                                        CampaignFleetAPI other)

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseDurationAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl in class BaseDurationAbility

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:

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