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

Class ExampleCustomEntityPlugin

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.ExampleCustomEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class ExampleCustomEntityPlugin
extends BaseCustomEntityPlugin

Field Summary

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

entity

Constructor Summary

Constructors

Constructor	Description
ExampleCustomEntityPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
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

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

Constructor Details

ExampleCustomEntityPlugin

public ExampleCustomEntityPlugin()

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