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

Class TransponderAbility

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

public class TransponderAbility
extends BaseToggleAbility

Field Summary

Fields

Modifier and Type	Field and Description
static float	CONFIRM_DURATION
static float	DETECTABILITY_FLAT
static float	DETECTABILITY_MULT

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

Method Summary

Modifier and Type	Method and 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.
void	deactivate() Toggleable or interruptable abilities should implement this method so that other abilities may turn them off or interrupt them if needed.
protected void	deactivateImpl()
protected java.lang.String	getActivationMessage()
protected java.lang.String	getActivationText()
java.awt.Color	getCooldownColor()
float	getCooldownFraction() 0 at start of cooldown, 1 at end.
protected java.lang.String	getDeactivationMessage()
protected java.lang.String	getDeactivationText()
java.lang.String	getFactionList(java.util.List<FactionAPI> factions)
java.util.List<FactionAPI>	getFactionsThatWouldBecomeHostile()
static java.util.List<FactionAPI>	getFactionsThatWouldBecomeHostile(CampaignFleetAPI fleet)
java.awt.Color	getProgressColor()
float	getProgressFraction() 0 at start of progress, 1 at end.
boolean	hasTooltip()
boolean	isCooldownRenderingAdditive()
boolean	isOnCooldown()
void	pressButton() Called from the UI when the button for this ability is pressed.
protected java.lang.Object	readResolve()
boolean	runWhilePaused()
boolean	showProgressIndicator()

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

activate, addIncompatibleToTooltip, cleanup, getActivateCooldownDays, getActivationDays, getCooldownLeft, getDeactivateCooldownDays, getDeactivationDays, getLevel, getLoopSoundUIPitch, getLoopSoundUIVolume, getLoopSoundWorldPitch, getLoopSoundWorldVolume, hasCustomButtonPressSounds, isActive, isUsable, setCooldownLeft, showActiveIndicator

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

addIncompatibleToTooltip, disableIncompatible, fleetJoinedBattle, fleetLeftBattle, fleetOpenedMarket, forceDisable, getActiveColor, getActiveLayers, getEntity, getFleet, getId, getInterruptedList, getLoopSoundUI, getLoopSoundWorld, getModId, getOffSoundUI, getOffSoundWorld, getOnSoundUI, getOnSoundWorld, getSpec, getSpriteName, getTooltipWidth, init, interruptIncompatible, isActiveOrInProgress, isCompatible, isDone, isInProgress, isTooltipExpandable, render, showCooldownIndicator

Methods inherited from class java.lang.Object

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

Field Detail

DETECTABILITY_MULT

public static final float DETECTABILITY_MULT

See Also:

Constant Field Values

DETECTABILITY_FLAT

public static final float DETECTABILITY_FLAT

See Also:

Constant Field Values

CONFIRM_DURATION

public static final float CONFIRM_DURATION

See Also:

Constant Field Values

Constructor Detail

TransponderAbility

public TransponderAbility()

Method Detail

getActivationText

protected java.lang.String getActivationText()

Overrides:

getActivationText in class BaseAbilityPlugin

getDeactivationText

protected java.lang.String getDeactivationText()

Overrides:

getDeactivationText 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

deactivate

public void deactivate()

Description copied from interface: AbilityPlugin

Toggleable or interruptable abilities should implement this method so that other abilities may turn them off or interrupt them if needed. Expected behavior: if (isActiveOrInProgress()) { }

Specified by:

deactivate in interface AbilityPlugin

Overrides:

deactivate in class BaseToggleAbility

deactivateImpl

protected void deactivateImpl()

Specified by:

deactivateImpl in class BaseToggleAbility

cleanupImpl

protected void cleanupImpl()

Specified by:

cleanupImpl 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

getFactionList

public java.lang.String getFactionList(java.util.List<FactionAPI> factions)

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface AbilityPlugin

Overrides:

hasTooltip in class BaseAbilityPlugin

getFactionsThatWouldBecomeHostile

public java.util.List<FactionAPI> getFactionsThatWouldBecomeHostile()

getFactionsThatWouldBecomeHostile

public static java.util.List<FactionAPI> getFactionsThatWouldBecomeHostile(CampaignFleetAPI fleet)

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.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Overrides:

runWhilePaused in class BaseToggleAbility

Returns:

whether advance() should be called while the campaign engine is paused.

showProgressIndicator

public boolean showProgressIndicator()

Specified by:

showProgressIndicator in interface AbilityPlugin

Overrides:

showProgressIndicator in class BaseToggleAbility

getProgressFraction

public float getProgressFraction()

Description copied from interface: AbilityPlugin

0 at start of progress, 1 at end.

Specified by:

getProgressFraction in interface AbilityPlugin

Overrides:

getProgressFraction in class BaseToggleAbility

Returns:

getProgressColor

public java.awt.Color getProgressColor()

Specified by:

getProgressColor in interface AbilityPlugin

Overrides:

getProgressColor in class BaseAbilityPlugin

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class BaseAbilityPlugin

pressButton

public void pressButton()

Description copied from interface: AbilityPlugin

Called from the UI when the button for this ability is pressed. Should not be called by the AI for other ability-using fleets, for example.

Specified by:

pressButton in interface AbilityPlugin

Overrides:

pressButton in class BaseToggleAbility

getDeactivationMessage

protected java.lang.String getDeactivationMessage()

getActivationMessage

protected java.lang.String getActivationMessage()

getCooldownFraction

public float getCooldownFraction()

Description copied from interface: AbilityPlugin

0 at start of cooldown, 1 at end.

Specified by:

getCooldownFraction in interface AbilityPlugin

Overrides:

getCooldownFraction in class BaseToggleAbility

Returns:

isOnCooldown

public boolean isOnCooldown()

Specified by:

isOnCooldown in interface AbilityPlugin

Overrides:

isOnCooldown in class BaseAbilityPlugin

getCooldownColor

public java.awt.Color getCooldownColor()

Specified by:

getCooldownColor in interface AbilityPlugin

Overrides:

getCooldownColor in class BaseAbilityPlugin

isCooldownRenderingAdditive

public boolean isCooldownRenderingAdditive()

Specified by:

isCooldownRenderingAdditive in interface AbilityPlugin

Overrides:

isCooldownRenderingAdditive in class BaseAbilityPlugin