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

Class GraviticScanAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class GraviticScanAbility
extends BaseToggleAbility

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMMODITY_ID
static float	COMMODITY_PER_DAY
protected GraviticScanData	data
static float	DETECTABILITY_PERCENT
protected float	phaseAngle
static float	SLIPSTREAM_DETECTION_RANGE
protected SpriteAPI	texture

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

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()
EnumSet<CampaignEngineLayers>	getActiveLayers()
CommoditySpecAPI	getCommodity()
protected String	getDeactivationText()
float	getRingRadius()
boolean	hasTooltip()
boolean	isUsable()	Whether the ability can be activated / the UI button corresponding to it is enabled.
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
boolean	showActiveIndicator()
boolean	showProgressIndicator()

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

activate, addIncompatibleToTooltip, 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, fleetJoinedBattle, fleetLeftBattle, fleetOpenedMarket, forceDisable, getActiveColor, getCooldownColor, 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, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Field Details

SLIPSTREAM_DETECTION_RANGE

public static float SLIPSTREAM_DETECTION_RANGE

COMMODITY_ID

public static String COMMODITY_ID

COMMODITY_PER_DAY

public static float COMMODITY_PER_DAY

DETECTABILITY_PERCENT

public static float DETECTABILITY_PERCENT

phaseAngle

protected float phaseAngle

data

protected GraviticScanData data

texture

protected transient SpriteAPI texture

Constructor Details

GraviticScanAbility

public GraviticScanAbility()

Method Details

getActivationText

protected String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

getDeactivationText

protected String getDeactivationText()

Overrides:

getDeactivationText in class BaseAbilityPlugin

activateImpl

protected void activateImpl()

Specified by:

activateImpl 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

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface AbilityPlugin

Overrides:

hasTooltip in class BaseAbilityPlugin

getActiveLayers

public EnumSet<CampaignEngineLayers> getActiveLayers()

Specified by:

getActiveLayers in interface AbilityPlugin

Overrides:

getActiveLayers in class BaseAbilityPlugin

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 BaseToggleAbility

Parameters:

amount - seconds elapsed during the last frame.

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

getCommodity

public CommoditySpecAPI getCommodity()

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:

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseToggleAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl in class BaseToggleAbility

getRingRadius

public float getRingRadius()

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Specified by:

render in interface AbilityPlugin

Overrides:

render in class BaseAbilityPlugin