BaseToggleAbility

java.lang.Object
- com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin
- - com.fs.starfarer.api.impl.campaign.abilities.BaseToggleAbility

All Implemented Interfaces:

AbilityPlugin, EveryFrameScript

Direct Known Subclasses:

GoDarkAbility, GraviticScanAbility, SustainedBurnAbility, ToggleAbilityWithCost, TransponderAbility
```
public abstract class BaseToggleAbility
extends BaseAbilityPlugin
```
Ability that can be toggled on and off. (Why use methods to pass in sound ids etc instead of passing them in to a constructor? Mainly so they don't need to go into the save file as they would if they were stored in member variables.)

Field Summary

Fields
Modifier and Type Field and Description

protected float cooldownLeft

protected boolean isActivateCooldown

protected float level

protected boolean turnedOn
- Fields inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin
  disableFrames, entity, id, PLAY_UI_SOUNDS_IN_WORLD_SOURCES, spec

Fields
Modifier and Type	Field and Description
`protected float`	`cooldownLeft`
`protected boolean`	`isActivateCooldown`
`protected float`	`level`
`protected boolean`	`turnedOn`

Constructor Summary

Constructors
Constructor and Description

BaseToggleAbility()

Constructors
Constructor and Description
`BaseToggleAbility()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Programmatic way to activate the ability.
`protected abstract void`	`activateImpl()`
`protected void`	`addIncompatibleToTooltip(TooltipMakerAPI tooltip, boolean expanded)`
`void`	`advance(float amount)` Use SectorAPI.getClock() to convert to campaign days.
`protected abstract void`	`applyEffect(float amount, float level)` Will be called once when level is 0 and consistently when level >0.
`void`	`cleanup()` After this method is called, it should be possible to remove the ability from the entity without any after-effects.
`protected abstract void`	`cleanupImpl()`
`void`	`deactivate()` Toggleable or interruptable abilities should implement this method so that other abilities may turn them off or interrupt them if needed.
`protected abstract void`	`deactivateImpl()`
`float`	`getActivateCooldownDays()`
`float`	`getActivationDays()`
`float`	`getCooldownFraction()` 0 at start of cooldown, 1 at end.
`float`	`getCooldownLeft()`
`float`	`getDeactivateCooldownDays()`
`float`	`getDeactivationDays()`
`float`	`getLevel()`
`float`	`getLoopSoundUIPitch()`
`float`	`getLoopSoundUIVolume()`
`float`	`getLoopSoundWorldPitch()`
`float`	`getLoopSoundWorldVolume()`
`float`	`getProgressFraction()` 0 at start of progress, 1 at end.
`boolean`	`hasCustomButtonPressSounds()`
`boolean`	`isActive()` Whether a toggle-style ability is turned on.
`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.
`boolean`	`runWhilePaused()`
`void`	`setCooldownLeft(float cooldownLeft)`
`boolean`	`showActiveIndicator()`
`boolean`	`showProgressIndicator()`

Methods inherited from class com.fs.starfarer.api.impl.campaign.abilities.BaseAbilityPlugin
addIncompatibleToTooltip, createTooltip, 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, hasTooltip, init, interruptIncompatible, isActiveOrInProgress, isCompatible, isCooldownRenderingAdditive, isDone, isInProgress, 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
  - turnedOn
```
protected boolean turnedOn
```
  - cooldownLeft
```
protected float cooldownLeft
```
  - isActivateCooldown
```
protected boolean isActivateCooldown
```
  - level
```
protected float level
```
- Constructor Detail
  - BaseToggleAbility
```
public BaseToggleAbility()
```
- Method Detail
  - getLoopSoundUIVolume
```
public float getLoopSoundUIVolume()
```
    Overrides:
    
    getLoopSoundUIVolume in class BaseAbilityPlugin
  - getLoopSoundUIPitch
```
public float getLoopSoundUIPitch()
```
    Overrides:
    
    getLoopSoundUIPitch in class BaseAbilityPlugin
  - getLoopSoundWorldVolume
```
public float getLoopSoundWorldVolume()
```
    Overrides:
    
    getLoopSoundWorldVolume in class BaseAbilityPlugin
  - getLoopSoundWorldPitch
```
public float getLoopSoundWorldPitch()
```
    Overrides:
    
    getLoopSoundWorldPitch in class BaseAbilityPlugin
  - getActivateCooldownDays
```
public float getActivateCooldownDays()
```
  - getDeactivateCooldownDays
```
public float getDeactivateCooldownDays()
```
  - getActivationDays
```
public float getActivationDays()
```
  - getDeactivationDays
```
public float getDeactivationDays()
```
  - activateImpl
```
protected abstract void activateImpl()
```
  - applyEffect
```
protected abstract void applyEffect(float amount,
                                    float level)
```
    Will be called once when level is 0 and consistently when level >0.
    
    Parameters:
    
    level -
  - deactivateImpl
```
protected abstract void deactivateImpl()
```
  - cleanupImpl
```
protected abstract void cleanupImpl()
```
  - getCooldownLeft
```
public float getCooldownLeft()
```
    Specified by:
    
    getCooldownLeft in interface AbilityPlugin
    
    Specified by:
    
    getCooldownLeft in class BaseAbilityPlugin
  - setCooldownLeft
```
public void setCooldownLeft(float cooldownLeft)
```
    Specified by:
    
    setCooldownLeft in interface AbilityPlugin
    
    Specified by:
    
    setCooldownLeft 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 BaseAbilityPlugin
    
    Parameters:
    
    amount - seconds elapsed during the last frame.
  - addIncompatibleToTooltip
```
protected void addIncompatibleToTooltip(TooltipMakerAPI tooltip,
                                        boolean expanded)
```
  - 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 BaseAbilityPlugin
    
    Returns:
  - 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 BaseAbilityPlugin
    
    Returns:
  - 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 BaseAbilityPlugin
    
    Returns:
  - showProgressIndicator
```
public boolean showProgressIndicator()
```
    Specified by:
    
    showProgressIndicator in interface AbilityPlugin
    
    Overrides:
    
    showProgressIndicator in class BaseAbilityPlugin
  - showActiveIndicator
```
public boolean showActiveIndicator()
```
    Specified by:
    
    showActiveIndicator in interface AbilityPlugin
    
    Overrides:
    
    showActiveIndicator 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 BaseAbilityPlugin
  - 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
    
    Overrides:
    
    activate in class BaseAbilityPlugin
  - 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 BaseAbilityPlugin
  - 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
    
    Overrides:
    
    cleanup in class BaseAbilityPlugin
  - 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
    
    Overrides:
    
    isActive in class BaseAbilityPlugin
    
    Returns:
  - hasCustomButtonPressSounds
```
public boolean hasCustomButtonPressSounds()
```
    Specified by:
    
    hasCustomButtonPressSounds in interface AbilityPlugin
    
    Overrides:
    
    hasCustomButtonPressSounds in class BaseAbilityPlugin
  - runWhilePaused
```
public boolean runWhilePaused()
```
    Specified by:
    
    runWhilePaused in interface EveryFrameScript
    
    Overrides:
    
    runWhilePaused in class BaseAbilityPlugin
    
    Returns:
    
    whether advance() should be called while the campaign engine is paused.
  - getLevel
```
public float getLevel()
```
    Specified by:
    
    getLevel in interface AbilityPlugin
    
    Overrides:
    
    getLevel in class BaseAbilityPlugin

Class BaseToggleAbility

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

turnedOn

cooldownLeft

isActivateCooldown

level

Constructor Detail

BaseToggleAbility

Method Detail

getLoopSoundUIVolume

getLoopSoundUIPitch

getLoopSoundWorldVolume

getLoopSoundWorldPitch

getActivateCooldownDays

getDeactivateCooldownDays

getActivationDays

getDeactivationDays

activateImpl

applyEffect

deactivateImpl

cleanupImpl

getCooldownLeft

setCooldownLeft

advance

addIncompatibleToTooltip

isUsable

getCooldownFraction

getProgressFraction

showProgressIndicator

showActiveIndicator

pressButton

activate

deactivate

cleanup

isActive

hasCustomButtonPressSounds

runWhilePaused

getLevel