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

Class ScavengeAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class ScavengeAbility
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	Description
ScavengeAbility()

Method Summary

Modifier and Type	Method	Description
protected void	activateImpl()
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
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()
protected String	getActivationText()
protected DebrisFieldTerrainPlugin	getDebrisField()
boolean	hasTooltip()
boolean	isUsable()	Whether the ability can be activated / the UI button corresponding to it is enabled.

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

activate, addIncompatibleToTooltip, 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, fleetLeftBattle, 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, isOnCooldown, isTooltipExpandable, readResolve, render, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Constructor Details

ScavengeAbility

public ScavengeAbility()

Method Details

getActivationText

protected String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

activateImpl

protected void activateImpl()

Specified by:

activateImpl in class BaseDurationAbility

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Overrides:

advance in class BaseDurationAbility

Parameters:

amount - seconds elapsed during the last frame.

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

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:

getDebrisField

protected DebrisFieldTerrainPlugin getDebrisField()

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