AbyssalLightEntityPlugin (Starfarer API)

java.lang.Object
- com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin
- - com.fs.starfarer.api.impl.campaign.AbyssalLightEntityPlugin

All Implemented Interfaces:: CustomCampaignEntityPlugin

public class AbyssalLightEntityPlugin
extends BaseCustomEntityPlugin

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbyssalLightEntityPlugin.AbyssalLightParams`
`static class`	`AbyssalLightEntityPlugin.AbyssalLightSoundStopper`
`static class`	`AbyssalLightEntityPlugin.DespawnType`

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`DESPAWN_POOF_THRESHOLD`
`protected AbyssalLightEntityPlugin.DespawnType`	`despawnType`
`protected FaderUtil`	`fader`
`protected FlickerUtilV2`	`flicker`
`protected float`	`flickerDur`
`protected float`	`frequencyMult`
`static float`	`GLOW_FREQUENCY`
`static float`	`MAX_DURATION`
`static float`	`MAX_SIZE`
`static float`	`MIN_DURATION`
`static float`	`MIN_SIZE`
`protected AbyssalLightEntityPlugin.AbyssalLightParams`	`params`
`protected float`	`phase`
`protected boolean`	`playedDespawnSound`
`static float`	`PLAYER_PROXIMITY_MAX_BRIGHTNESS_AT`
`static float`	`PLAYER_PROXIMITY_MIN_BRIGHTNESS`
`static float`	`PLAYER_PROXIMITY_MIN_BRIGHTNESS_AT`
`protected float`	`untilFrequencyChange`
`protected float`	`untilSoundPlayed`

Fields inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin
entity

Constructor Summary

Constructors
Constructor and Description

AbyssalLightEntityPlugin()

Constructors
Constructor and Description
`AbyssalLightEntityPlugin()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`advance(float amount)`
`void`	`despawn(AbyssalLightEntityPlugin.DespawnType type)`
`float`	`getDespawnProgress()`
`float`	`getFlickerBasedMult()`
`float`	`getGlowAlpha()`
`AbyssalLightEntityPlugin.AbyssalLightParams`	`getParams()`
`static float`	`getPlayerProximityBasedBrightnessFactor(SectorEntityToken entity)`
`static float`	`getPlayerProximityBasedBrightnessFactor(Vector2f loc)`
`static float`	`getProximityBasedBrightnessFactor(CampaignFleetAPI from, Vector2f loc)`
`float`	`getRenderRange()` How far away from the viewport the center of this entity can be before it stops being rendered.
`void`	`init(SectorEntityToken entity, java.lang.Object pluginParams)`
`boolean`	`isDespawning()`
`void`	`render(CampaignEngineLayers layer, ViewportAPI viewport)` Should only render for specified layer.
`void`	`updateFrequency(float amount)`
`void`	`updateSoundDelayAndPlaySound(float amount)`

Methods inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin
appendToCampaignTooltip, createMapTooltip, getMapTooltipWidth, hasCustomMapTooltip, isMapTooltipExpandable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIN_DURATION
```
public static float MIN_DURATION
```
  - MAX_DURATION
```
public static float MAX_DURATION
```
  - MIN_SIZE
```
public static float MIN_SIZE
```
  - MAX_SIZE
```
public static float MAX_SIZE
```
  - DESPAWN_POOF_THRESHOLD
```
public static float DESPAWN_POOF_THRESHOLD
```
  - GLOW_FREQUENCY
```
public static float GLOW_FREQUENCY
```
  - PLAYER_PROXIMITY_MIN_BRIGHTNESS_AT
```
public static float PLAYER_PROXIMITY_MIN_BRIGHTNESS_AT
```
  - PLAYER_PROXIMITY_MAX_BRIGHTNESS_AT
```
public static float PLAYER_PROXIMITY_MAX_BRIGHTNESS_AT
```
  - PLAYER_PROXIMITY_MIN_BRIGHTNESS
```
public static float PLAYER_PROXIMITY_MIN_BRIGHTNESS
```
  - phase
```
protected float phase
```
  - frequencyMult
```
protected float frequencyMult
```
  - flicker
```
protected FlickerUtilV2 flicker
```
  - fader
```
protected FaderUtil fader
```
  - params
```
protected AbyssalLightEntityPlugin.AbyssalLightParams params
```
  - untilFrequencyChange
```
protected float untilFrequencyChange
```
  - untilSoundPlayed
```
protected float untilSoundPlayed
```
  - flickerDur
```
protected float flickerDur
```
  - despawnType
```
protected AbyssalLightEntityPlugin.DespawnType despawnType
```
  - playedDespawnSound
```
protected boolean playedDespawnSound
```
- Constructor Detail
  - AbyssalLightEntityPlugin
```
public AbyssalLightEntityPlugin()
```
- Method Detail
  - init
```
public void init(SectorEntityToken entity,
        java.lang.Object pluginParams)
```
    Specified by:
    
    init in interface CustomCampaignEntityPlugin
    
    Overrides:
    
    init in class BaseCustomEntityPlugin
  - isDespawning
```
public boolean isDespawning()
```
  - despawn
```
public void despawn(AbyssalLightEntityPlugin.DespawnType type)
```
  - updateSoundDelayAndPlaySound
```
public void updateSoundDelayAndPlaySound(float amount)
```
  - updateFrequency
```
public void updateFrequency(float amount)
```
  - getParams
```
public AbyssalLightEntityPlugin.AbyssalLightParams getParams()
```
  - advance
```
public void advance(float amount)
```
    Specified by:
    
    advance in interface CustomCampaignEntityPlugin
    
    Overrides:
    
    advance in class BaseCustomEntityPlugin
    
    Parameters:
    amount - in seconds. Use SectorAPI.getClock() to figure out how many campaign days that is.
  - getFlickerBasedMult
```
public float getFlickerBasedMult()
```
  - getGlowAlpha
```
public float getGlowAlpha()
```
  - getRenderRange
```
public float getRenderRange()
```
    Description copied from interface: CustomCampaignEntityPlugin
    
    How far away from the viewport the center of this entity can be before it stops being rendered. Should at least be the radius of the entity; sometimes more may be necessary depending on the visual effect desired.
    
    Specified by:
    
    getRenderRange in interface CustomCampaignEntityPlugin
    
    Overrides:
    
    getRenderRange in class BaseCustomEntityPlugin
    
    Returns:
  - getDespawnProgress
```
public float getDespawnProgress()
```
  - render
```
public void render(CampaignEngineLayers layer,
          ViewportAPI viewport)
```
    Description copied from interface: CustomCampaignEntityPlugin
    
    Should only render for specified layer. Will be called once per each layer, per frame. Needs to respect viewport.getAlphaMult() - i.e. use that alpha value for rendering. Needs to render at the entity's location - there's no translation before this method call. If a sprite is specified, it will be rendered in the bottommost layer of the layers this entity renders for. This method will be called after the sprite has rendered.
    
    Specified by:
    
    render in interface CustomCampaignEntityPlugin
    
    Overrides:
    
    render in class BaseCustomEntityPlugin
  - getPlayerProximityBasedBrightnessFactor
```
public static float getPlayerProximityBasedBrightnessFactor(SectorEntityToken entity)
```
  - getPlayerProximityBasedBrightnessFactor
```
public static float getPlayerProximityBasedBrightnessFactor(Vector2f loc)
```
  - getProximityBasedBrightnessFactor
```
public static float getProximityBasedBrightnessFactor(CampaignFleetAPI from,
                                      Vector2f loc)
```

Class AbyssalLightEntityPlugin

Nested Class Summary

Field Summary

Fields inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

Constructor Summary

Method Summary

Methods inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

Methods inherited from class java.lang.Object

Field Detail

MIN_DURATION

MAX_DURATION

MIN_SIZE

MAX_SIZE

DESPAWN_POOF_THRESHOLD

GLOW_FREQUENCY

PLAYER_PROXIMITY_MIN_BRIGHTNESS_AT

PLAYER_PROXIMITY_MAX_BRIGHTNESS_AT

PLAYER_PROXIMITY_MIN_BRIGHTNESS

phase

frequencyMult

flicker

fader

params

untilFrequencyChange

untilSoundPlayed

flickerDur

despawnType

playedDespawnSound

Constructor Detail

AbyssalLightEntityPlugin

Method Detail

init

isDespawning

despawn

updateSoundDelayAndPlaySound

updateFrequency

getParams

advance

getFlickerBasedMult

getGlowAlpha

getRenderRange

getDespawnProgress

render

getPlayerProximityBasedBrightnessFactor

getPlayerProximityBasedBrightnessFactor

getProximityBasedBrightnessFactor