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

Class RemoteSurveyAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class RemoteSurveyAbility
extends BaseDurationAbility

Field Summary

Fields

Modifier and Type	Field and Description
static float	ACCELERATION_MULT
static java.lang.String	ALREADY_DID_IN_SYSTEM
static float	DETECTABILITY_RANGE_BONUS
protected boolean	performed
static float	SURVEY_RANGE

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

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()
PlanetAPI	findBestPlanet()
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, 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, fleetLeftBattle, fleetOpenedMarket, forceDisable, getActivationText, 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

ALREADY_DID_IN_SYSTEM

public static final java.lang.String ALREADY_DID_IN_SYSTEM

See Also:

Constant Field Values

SURVEY_RANGE

public static final float SURVEY_RANGE

See Also:

Constant Field Values

DETECTABILITY_RANGE_BONUS

public static final float DETECTABILITY_RANGE_BONUS

See Also:

Constant Field Values

ACCELERATION_MULT

public static final float ACCELERATION_MULT

See Also:

Constant Field Values

performed

protected boolean performed

Constructor Detail

RemoteSurveyAbility

public RemoteSurveyAbility()

Method Detail

activateImpl

protected void activateImpl()

Specified by:

activateImpl 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

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:

findBestPlanet

public PlanetAPI findBestPlanet()

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseDurationAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl in class BaseDurationAbility

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