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

Class SustainedBurnAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class SustainedBurnAbility
extends BaseToggleAbility

Field Summary

Fields

Modifier and Type	Field and Description
static float	ACCELERATION_MULT
static float	DETECTABILITY_PERCENT
static float	MAX_BURN_PERCENT
static java.lang.String	SB_NO_SLOW
static java.lang.String	SB_NO_STOP

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

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	fleetJoinedBattle(BattleAPI battle)
void	fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
protected java.lang.String	getActivationText()
boolean	hasTooltip()
boolean	isUsable() Whether the ability can be activated / the UI button corresponding to it is enabled.
boolean	showActiveIndicator()
boolean	showProgressIndicator()

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

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

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

addIncompatibleToTooltip, disableIncompatible, fleetOpenedMarket, 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, isInProgress, 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

SB_NO_STOP

public static java.lang.String SB_NO_STOP

SB_NO_SLOW

public static java.lang.String SB_NO_SLOW

DETECTABILITY_PERCENT

public static float DETECTABILITY_PERCENT

MAX_BURN_PERCENT

public static float MAX_BURN_PERCENT

ACCELERATION_MULT

public static float ACCELERATION_MULT

Constructor Detail

SustainedBurnAbility

public SustainedBurnAbility()

Method Detail

getActivationText

protected java.lang.String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseToggleAbility

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

showProgressIndicator

public boolean showProgressIndicator()

Specified by:

showProgressIndicator in interface AbilityPlugin

Overrides:

showProgressIndicator in class BaseToggleAbility

showActiveIndicator

public boolean showActiveIndicator()

Specified by:

showActiveIndicator in interface AbilityPlugin

Overrides:

showActiveIndicator in class BaseToggleAbility

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

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:

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

fleetJoinedBattle

public void fleetJoinedBattle(BattleAPI battle)

Specified by:

fleetJoinedBattle in interface AbilityPlugin

Overrides:

fleetJoinedBattle in class BaseAbilityPlugin