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

Class BaseAbilityPlugin

java.lang.Object

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

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

Direct Known Subclasses:

BaseDurationAbility, BaseToggleAbility

public abstract class BaseAbilityPlugin
extends Object
implements AbilityPlugin, EveryFrameScript

Field Summary

Fields

Modifier and Type	Field	Description
protected int	disableFrames
protected SectorEntityToken	entity
protected String	id
static boolean	PLAY_UI_SOUNDS_IN_WORLD_SOURCES
protected AbilitySpecAPI	spec

Constructor Summary

Constructors

Constructor	Description
BaseAbilityPlugin()

Method Summary

Modifier and Type	Method	Description
void	activate()	Programmatic way to activate the ability.
protected void	addIncompatibleToTooltip(TooltipMakerAPI tooltip, String desc, String descShort, boolean expanded)
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
void	cleanup()	After this method is called, it should be possible to remove the ability from the entity without any after-effects.
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	disableIncompatible()
void	fleetJoinedBattle(BattleAPI battle)
void	fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	fleetOpenedMarket(MarketAPI market)	Only called for the player fleet.
void	forceDisable()	Make this ability unusable for 1-2 frames after this call.
protected String	getActivationText()
Color	getActiveColor()
EnumSet<CampaignEngineLayers>	getActiveLayers()
Color	getCooldownColor()
float	getCooldownFraction()	0 at start of cooldown, 1 at end.
abstract float	getCooldownLeft()
protected String	getDeactivationText()
SectorEntityToken	getEntity()
CampaignFleetAPI	getFleet()
String	getId()
List<AbilityPlugin>	getInterruptedList()
float	getLevel()
String	getLoopSoundUI()
float	getLoopSoundUIPitch()
float	getLoopSoundUIVolume()
String	getLoopSoundWorld()
float	getLoopSoundWorldPitch()
float	getLoopSoundWorldVolume()
String	getModId()
String	getOffSoundUI()
String	getOffSoundWorld()
String	getOnSoundUI()
String	getOnSoundWorld()
Color	getProgressColor()
float	getProgressFraction()	0 at start of progress, 1 at end.
AbilitySpecAPI	getSpec()
String	getSpriteName()
float	getTooltipWidth()
boolean	hasCustomButtonPressSounds()
boolean	hasTooltip()
void	init(String id, SectorEntityToken entity)
protected void	interruptIncompatible()
boolean	isActive()	Whether a toggle-style ability is turned on.
boolean	isActiveOrInProgress()	Should return (isActive() || getProgressFraction() > 0).
boolean	isCompatible(AbilityPlugin other)
boolean	isCooldownRenderingAdditive()
boolean	isDone()
boolean	isInProgress()
boolean	isOnCooldown()
boolean	isTooltipExpandable()
boolean	isUsable()	Whether the ability can be activated / the UI button corresponding to it is enabled.
void	pressButton()	Called from the UI when the button for this ability is pressed.
protected Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
boolean	runWhilePaused()
abstract void	setCooldownLeft(float days)
boolean	showActiveIndicator()
boolean	showCooldownIndicator()
boolean	showProgressIndicator()

Methods inherited from class java.lang.Object

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

Field Details

PLAY_UI_SOUNDS_IN_WORLD_SOURCES

public static boolean PLAY_UI_SOUNDS_IN_WORLD_SOURCES

entity

protected SectorEntityToken entity

id

protected String id

disableFrames

protected int disableFrames

spec

protected transient AbilitySpecAPI spec

Constructor Details

BaseAbilityPlugin

public BaseAbilityPlugin()

Method Details

init

public void init(String id,
 SectorEntityToken entity)

Specified by:

init in interface AbilityPlugin

readResolve

protected Object readResolve()

getOnSoundUI

public String getOnSoundUI()

getOnSoundWorld

public String getOnSoundWorld()

getOffSoundUI

public String getOffSoundUI()

getOffSoundWorld

public String getOffSoundWorld()

getLoopSoundUI

public String getLoopSoundUI()

getLoopSoundUIVolume

public float getLoopSoundUIVolume()

getLoopSoundUIPitch

public float getLoopSoundUIPitch()

getLoopSoundWorld

public String getLoopSoundWorld()

getLoopSoundWorldVolume

public float getLoopSoundWorldVolume()

getLoopSoundWorldPitch

public float getLoopSoundWorldPitch()

interruptIncompatible

protected void interruptIncompatible()

disableIncompatible

protected void disableIncompatible()

isCompatible

public boolean isCompatible(AbilityPlugin other)

addIncompatibleToTooltip

protected void addIncompatibleToTooltip(TooltipMakerAPI tooltip,
 String desc,
 String descShort,
 boolean expanded)

getInterruptedList

public List<AbilityPlugin> getInterruptedList()

getModId

public String getModId()

getFleet

public CampaignFleetAPI getFleet()

getEntity

public SectorEntityToken getEntity()

Specified by:

getEntity in interface AbilityPlugin

getId

public String getId()

Specified by:

getId in interface AbilityPlugin

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

Parameters:

amount - seconds elapsed during the last frame.

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

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

showActiveIndicator

public boolean showActiveIndicator()

Specified by:

showActiveIndicator in interface AbilityPlugin

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

Returns:

forceDisable

public void forceDisable()

Description copied from interface: AbilityPlugin

Make this ability unusable for 1-2 frames after this call.

Specified by:

forceDisable in interface AbilityPlugin

getCooldownFraction

public float getCooldownFraction()

Description copied from interface: AbilityPlugin

0 at start of cooldown, 1 at end.

Specified by:

getCooldownFraction in interface AbilityPlugin

Returns:

hasCustomButtonPressSounds

public boolean hasCustomButtonPressSounds()

Specified by:

hasCustomButtonPressSounds in interface AbilityPlugin

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface AbilityPlugin

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

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface AbilityPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface AbilityPlugin

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

getSpriteName

public String getSpriteName()

Specified by:

getSpriteName in interface AbilityPlugin

activate

public void activate()

Description copied from interface: AbilityPlugin

Programmatic way to activate the ability. Expected behavior: if (!isActiveOrInProgress()) { }

Specified by:

activate in interface AbilityPlugin

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

getCooldownColor

public Color getCooldownColor()

Specified by:

getCooldownColor in interface AbilityPlugin

getProgressColor

public Color getProgressColor()

Specified by:

getProgressColor in interface AbilityPlugin

getActiveColor

public Color getActiveColor()

Specified by:

getActiveColor in interface AbilityPlugin

getProgressFraction

public float getProgressFraction()

Description copied from interface: AbilityPlugin

0 at start of progress, 1 at end.

Specified by:

getProgressFraction in interface AbilityPlugin

Returns:

isActive

public boolean isActive()

Description copied from interface: AbilityPlugin

Whether a toggle-style ability is turned on. Duration abilities will always return false here; use isInProgress() to get their status.

Specified by:

isActive in interface AbilityPlugin

Returns:

isActiveOrInProgress

public boolean isActiveOrInProgress()

Description copied from interface: AbilityPlugin

Should return (isActive() || getProgressFraction() > 0).

Specified by:

isActiveOrInProgress in interface AbilityPlugin

Returns:

isInProgress

public boolean isInProgress()

Specified by:

isInProgress in interface AbilityPlugin

showCooldownIndicator

public boolean showCooldownIndicator()

Specified by:

showCooldownIndicator in interface AbilityPlugin

showProgressIndicator

public boolean showProgressIndicator()

Specified by:

showProgressIndicator in interface AbilityPlugin

isOnCooldown

public boolean isOnCooldown()

Specified by:

isOnCooldown in interface AbilityPlugin

cleanup

public void cleanup()

Description copied from interface: AbilityPlugin

After this method is called, it should be possible to remove the ability from the entity without any after-effects.

Specified by:

cleanup in interface AbilityPlugin

isCooldownRenderingAdditive

public boolean isCooldownRenderingAdditive()

Specified by:

isCooldownRenderingAdditive in interface AbilityPlugin

setCooldownLeft

public abstract void setCooldownLeft(float days)

Specified by:

setCooldownLeft in interface AbilityPlugin

getCooldownLeft

public abstract float getCooldownLeft()

Specified by:

getCooldownLeft in interface AbilityPlugin

getActivationText

protected String getActivationText()

getDeactivationText

protected String getDeactivationText()

fleetJoinedBattle

public void fleetJoinedBattle(BattleAPI battle)

Specified by:

fleetJoinedBattle in interface AbilityPlugin

fleetLeftBattle

public void fleetLeftBattle(BattleAPI battle,
 boolean engagedInHostilities)

Specified by:

fleetLeftBattle in interface AbilityPlugin

fleetOpenedMarket

public void fleetOpenedMarket(MarketAPI market)

Description copied from interface: AbilityPlugin

Only called for the player fleet.

Specified by:

fleetOpenedMarket in interface AbilityPlugin

getSpec

public AbilitySpecAPI getSpec()

Specified by:

getSpec in interface AbilityPlugin

getActiveLayers

public EnumSet<CampaignEngineLayers> getActiveLayers()

Specified by:

getActiveLayers in interface AbilityPlugin

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Specified by:

render in interface AbilityPlugin

getLevel

public float getLevel()

Specified by:

getLevel in interface AbilityPlugin