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

Class DistressCallAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript, RouteManager.RouteFleetSpawner

public class DistressCallAbility
extends BaseDurationAbility
implements RouteManager.RouteFleetSpawner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistressCallAbility.AbilityUseData
static class	DistressCallAbility.DistressCallOutcome
static class	DistressCallAbility.DistressResponseData

Field Summary

Fields

Modifier and Type	Field and Description
static float	DAYS_TO_TRACK_USAGE
protected long	lastUsed
static float	NEARBY_USE_RADIUS_LY
static float	NEARBY_USE_TIMEOUT_DAYS
protected int	numTimesUsed
protected boolean	performed
protected TimeoutTracker<DistressCallAbility.AbilityUseData>	uses

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

Method Summary

Modifier and Type	Method and Description
protected void	activateImpl()
protected void	addHelpScript(float delayDays, StarSystemAPI system, JumpPointAPI inner, JumpPointAPI outer)
protected void	addPiratesScript(float delayDays, StarSystemAPI system, JumpPointAPI inner, JumpPointAPI outer)
protected void	addResponseScript(float delayDays, DistressCallAbility.DistressCallOutcome outcome)
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()
int	getNumUsesInLastPeriod()
TimeoutTracker<DistressCallAbility.AbilityUseData>	getUses()
boolean	hasTooltip()
boolean	isUsable() Whether the ability can be activated / the UI button corresponding to it is enabled.
protected java.lang.Object	readResolve()
void	reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)
boolean	shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)
boolean	shouldRepeat(RouteManager.RouteData route)
CampaignFleetAPI	spawnFleet(RouteManager.RouteData route)
boolean	wasUsedNearby(float withinDays, org.lwjgl.util.vector.Vector2f locInHyper, float withinRangeLY)

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, 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, render, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Field Detail

NEARBY_USE_TIMEOUT_DAYS

public static final float NEARBY_USE_TIMEOUT_DAYS

See Also:

Constant Field Values

NEARBY_USE_RADIUS_LY

public static final float NEARBY_USE_RADIUS_LY

See Also:

Constant Field Values

DAYS_TO_TRACK_USAGE

public static final float DAYS_TO_TRACK_USAGE

See Also:

Constant Field Values

performed

protected boolean performed

numTimesUsed

protected int numTimesUsed

lastUsed

protected long lastUsed

uses

protected TimeoutTracker<DistressCallAbility.AbilityUseData> uses

Constructor Detail

DistressCallAbility

public DistressCallAbility()

Method Detail

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class BaseAbilityPlugin

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

wasUsedNearby

public boolean wasUsedNearby(float withinDays,
                             org.lwjgl.util.vector.Vector2f locInHyper,
                             float withinRangeLY)

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.

getUses

public TimeoutTracker<DistressCallAbility.AbilityUseData> getUses()

getNumUsesInLastPeriod

public int getNumUsesInLastPeriod()

addResponseScript

protected void addResponseScript(float delayDays,
                                 DistressCallAbility.DistressCallOutcome outcome)

addPiratesScript

protected void addPiratesScript(float delayDays,
                                StarSystemAPI system,
                                JumpPointAPI inner,
                                JumpPointAPI outer)

addHelpScript

protected void addHelpScript(float delayDays,
                             StarSystemAPI system,
                             JumpPointAPI inner,
                             JumpPointAPI outer)

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:

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

spawnFleet

public CampaignFleetAPI spawnFleet(RouteManager.RouteData route)

Specified by:

spawnFleet in interface RouteManager.RouteFleetSpawner

reportAboutToBeDespawnedByRouteManager

public void reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)

Specified by:

reportAboutToBeDespawnedByRouteManager in interface RouteManager.RouteFleetSpawner

shouldCancelRouteAfterDelayCheck

public boolean shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)

Specified by:

shouldCancelRouteAfterDelayCheck in interface RouteManager.RouteFleetSpawner

shouldRepeat

public boolean shouldRepeat(RouteManager.RouteData route)

Specified by:

shouldRepeat in interface RouteManager.RouteFleetSpawner