Class AbyssalLightEntityPlugin
java.lang.Object
com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin
com.fs.starfarer.api.impl.campaign.AbyssalLightEntityPlugin
- All Implemented Interfaces:
CustomCampaignEntityPlugin
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected float
static float
protected AbyssalLightEntityPlugin.DespawnType
static float
protected FaderUtil
protected FlickerUtilV2
protected float
protected float
static float
static float
static float
static float
static float
protected float
protected boolean
static float
static float
static float
static float
protected float
protected float
Fields inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin
entity
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
advance
(float amount) void
float
float
float
static float
static float
getPlayerProximityBasedBrightnessFactor
(org.lwjgl.util.vector.Vector2f loc) static float
getProximityBasedBrightnessFactor
(CampaignFleetAPI from, org.lwjgl.util.vector.Vector2f loc) float
How far away from the viewport the center of this entity can be before it stops being rendered.void
init
(SectorEntityToken entity, Object pluginParams) boolean
boolean
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
Methods inherited from interface com.fs.starfarer.api.campaign.CustomCampaignEntityPlugin
isRenderWhenViewportAlphaMultIsZero
-
Field Details
-
SENSOR_BURST_TRIGGER_RANGE
public static float SENSOR_BURST_TRIGGER_RANGE -
DWELLER_TRIGGER_RANGE
public static float DWELLER_TRIGGER_RANGE -
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
-
fader
-
params
-
untilFrequencyChange
protected float untilFrequencyChange -
untilSoundPlayed
protected float untilSoundPlayed -
flickerDur
protected float flickerDur -
abilityResponseFlickerTimeout
protected float abilityResponseFlickerTimeout -
despawnType
-
playedDespawnSound
protected boolean playedDespawnSound
-
-
Constructor Details
-
AbyssalLightEntityPlugin
public AbyssalLightEntityPlugin()
-
-
Method Details
-
init
- Specified by:
init
in interfaceCustomCampaignEntityPlugin
- Overrides:
init
in classBaseCustomEntityPlugin
-
isDespawning
public boolean isDespawning() -
despawn
-
updateSoundDelayAndPlaySound
public void updateSoundDelayAndPlaySound(float amount) -
updateFrequency
public void updateFrequency(float amount) -
getParams
-
isDweller
public boolean isDweller() -
advance
public void advance(float amount) - Specified by:
advance
in interfaceCustomCampaignEntityPlugin
- Overrides:
advance
in classBaseCustomEntityPlugin
- 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 interfaceCustomCampaignEntityPlugin
- Overrides:
getRenderRange
in classBaseCustomEntityPlugin
- Returns:
-
getDespawnProgress
public float getDespawnProgress() -
render
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 interfaceCustomCampaignEntityPlugin
- Overrides:
render
in classBaseCustomEntityPlugin
-
getPlayerProximityBasedBrightnessFactor
-
getPlayerProximityBasedBrightnessFactor
public static float getPlayerProximityBasedBrightnessFactor(org.lwjgl.util.vector.Vector2f loc) -
getProximityBasedBrightnessFactor
public static float getProximityBasedBrightnessFactor(CampaignFleetAPI from, org.lwjgl.util.vector.Vector2f loc)
-