FusionLampEntityPlugin

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

All Implemented Interfaces:: CustomCampaignEntityPlugin

public class FusionLampEntityPlugin
extends BaseCustomEntityPlugin

Field Summary

Fields
Modifier and Type	Field and Description
`protected FlickerUtilV2`	`flicker`
`static java.awt.Color`	`GLOW_COLOR`
`static java.lang.String`	`GLOW_COLOR_KEY`
`static float`	`GLOW_FREQUENCY`
`static java.awt.Color`	`LIGHT_COLOR`
`static java.lang.String`	`LIGHT_COLOR_KEY`
`protected float`	`phase`
`static java.lang.String`	`VOLATILES_SHORTAGE_KEY`

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

Constructor Summary

Constructors
Constructor and Description

FusionLampEntityPlugin()

Constructors
Constructor and Description
`FusionLampEntityPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`advance(float amount)`
`float`	`getFlickerBasedMult()`
`float`	`getGlowAlpha()`
`java.awt.Color`	`getGlowColor()`
`float`	`getLightAlpha()`
`java.awt.Color`	`getLightColor()`
`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)`
`void`	`render(CampaignEngineLayers layer, ViewportAPI viewport)` Should only render for specified layer.
`void`	`setGlowColor(java.awt.Color color)`
`void`	`setLightColor(java.awt.Color color)`

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 Detail
  - GLOW_COLOR
```
public static java.awt.Color GLOW_COLOR
```
  - LIGHT_COLOR
```
public static java.awt.Color LIGHT_COLOR
```
  - VOLATILES_SHORTAGE_KEY
```
public static java.lang.String VOLATILES_SHORTAGE_KEY
```
  - GLOW_COLOR_KEY
```
public static java.lang.String GLOW_COLOR_KEY
```
  - LIGHT_COLOR_KEY
```
public static java.lang.String LIGHT_COLOR_KEY
```
  - GLOW_FREQUENCY
```
public static float GLOW_FREQUENCY
```
  - phase
```
protected float phase
```
  - flicker
```
protected FlickerUtilV2 flicker
```
- Constructor Detail
  - FusionLampEntityPlugin
```
public FusionLampEntityPlugin()
```
- Method Detail
  - init
```
public void init(SectorEntityToken entity,
                 java.lang.Object pluginParams)
```
    Specified by:
    
    init in interface CustomCampaignEntityPlugin
    
    Overrides:
    
    init in class BaseCustomEntityPlugin
  - 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()
```
  - getLightAlpha
```
public float getLightAlpha()
```
  - getGlowColor
```
public java.awt.Color getGlowColor()
```
  - getLightColor
```
public java.awt.Color getLightColor()
```
  - setGlowColor
```
public void setGlowColor(java.awt.Color color)
```
  - setLightColor
```
public void setLightColor(java.awt.Color color)
```
  - 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:
  - 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

Class FusionLampEntityPlugin

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

Methods inherited from interface com.fs.starfarer.api.campaign.CustomCampaignEntityPlugin

Field Detail

GLOW_COLOR

LIGHT_COLOR

VOLATILES_SHORTAGE_KEY

GLOW_COLOR_KEY

LIGHT_COLOR_KEY

GLOW_FREQUENCY

phase

flicker

Constructor Detail

FusionLampEntityPlugin

Method Detail

init

advance

getFlickerBasedMult

getGlowAlpha

getLightAlpha

getGlowColor

getLightColor

setGlowColor

setLightColor

getRenderRange

render