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

Class WarningBeaconEntityPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

com.fs.starfarer.api.impl.campaign.WarningBeaconEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class WarningBeaconEntityPlugin
extends BaseCustomEntityPlugin

Field Summary

Fields

Modifier and Type	Field	Description
static String	GLOW_COLOR_KEY
static float	GLOW_FREQUENCY
static String	PING_COLOR_KEY
static String	PING_FREQ_KEY
static String	PING_ID_KEY

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

entity

Constructor Summary

Constructors

Constructor	Description
WarningBeaconEntityPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
void	appendToCampaignTooltip(TooltipMakerAPI tooltip, SectorEntityToken.VisibilityLevel level)
void	createMapTooltip(TooltipMakerAPI tooltip, boolean expanded)
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
boolean	hasCustomMapTooltip()
void	init(SectorEntityToken entity, Object pluginParams)
void	render(CampaignEngineLayers layer, ViewportAPI viewport)	Should only render for specified layer.

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

getMapTooltipWidth, 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

GLOW_COLOR_KEY

public static String GLOW_COLOR_KEY

PING_COLOR_KEY

public static String PING_COLOR_KEY

PING_ID_KEY

public static String PING_ID_KEY

PING_FREQ_KEY

public static String PING_FREQ_KEY

GLOW_FREQUENCY

public static float GLOW_FREQUENCY

Constructor Details

WarningBeaconEntityPlugin

public WarningBeaconEntityPlugin()

Method Details

init

public void init(SectorEntityToken entity,
 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.

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

createMapTooltip

public void createMapTooltip(TooltipMakerAPI tooltip,
 boolean expanded)

Specified by:

createMapTooltip in interface CustomCampaignEntityPlugin

Overrides:

createMapTooltip in class BaseCustomEntityPlugin

hasCustomMapTooltip

public boolean hasCustomMapTooltip()

Specified by:

hasCustomMapTooltip in interface CustomCampaignEntityPlugin

Overrides:

hasCustomMapTooltip in class BaseCustomEntityPlugin

appendToCampaignTooltip

public void appendToCampaignTooltip(TooltipMakerAPI tooltip,
 SectorEntityToken.VisibilityLevel level)

Specified by:

appendToCampaignTooltip in interface CustomCampaignEntityPlugin

Overrides:

appendToCampaignTooltip in class BaseCustomEntityPlugin