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

Class FractureJumpAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class FractureJumpAbility
extends BaseDurationAbility

Field Summary

Fields

Modifier and Type	Field and Description
static float	CR_COST_MULT
static float	FUEL_USE_MULT
static float	NASCENT_JUMP_DIST
protected EveryFrameScript	ping
protected java.lang.Boolean	primed
protected NascentGravityWellAPI	well

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

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 boolean	canUseToJumpToHyper()
protected boolean	canUseToJumpToSystem()
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.
void	deactivate() Toggleable or interruptable abilities should implement this method so that other abilities may turn them off or interrupt them if needed.
protected void	deactivateImpl()
void	fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	fleetOpenedMarket(MarketAPI market) Only called for the player fleet.
protected java.lang.String	getActivationText()
java.awt.Color	getCooldownColor()
float	getCooldownFraction() 0 at start of cooldown, 1 at end.
protected float	getCRCostMult(CampaignFleetAPI fleet)
NascentGravityWellAPI	getNearestWell(float maxDist)
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()
boolean	showCooldownIndicator()

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

activate, addIncompatibleToTooltip, advance, cleanup, 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, 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

Methods inherited from class java.lang.Object

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

Field Detail

CR_COST_MULT

public static float CR_COST_MULT

FUEL_USE_MULT

public static float FUEL_USE_MULT

NASCENT_JUMP_DIST

public static float NASCENT_JUMP_DIST

primed

protected java.lang.Boolean primed

well

protected NascentGravityWellAPI well

ping

protected EveryFrameScript ping

Constructor Detail

FractureJumpAbility

public FractureJumpAbility()

Method Detail

canUseToJumpToHyper

protected boolean canUseToJumpToHyper()

canUseToJumpToSystem

protected boolean canUseToJumpToSystem()

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseDurationAbility

deactivate

public void deactivate()

Description copied from interface: AbilityPlugin

Toggleable or interruptable abilities should implement this method so that other abilities may turn them off or interrupt them if needed. Expected behavior: if (isActiveOrInProgress()) { }

Specified by:

deactivate in interface AbilityPlugin

Overrides:

deactivate in class BaseDurationAbility

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

getActivationText

protected java.lang.String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

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:

getNearestWell

public NascentGravityWellAPI getNearestWell(float maxDist)

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

getNonReadyShips

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

computeFuelCost

protected float computeFuelCost()

getCRCostMult

protected float getCRCostMult(CampaignFleetAPI fleet)

computeSupplyCost

protected float computeSupplyCost()

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 BaseDurationAbility

Returns:

showCooldownIndicator

public boolean showCooldownIndicator()

Specified by:

showCooldownIndicator in interface AbilityPlugin

Overrides:

showCooldownIndicator in class BaseAbilityPlugin

isOnCooldown

public boolean isOnCooldown()

Specified by:

isOnCooldown in interface AbilityPlugin

Overrides:

isOnCooldown in class BaseAbilityPlugin

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