com.fs.starfarer.api.impl.campaign

Class BaseCustomEntityPlugin

java.lang.Object

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

All Implemented Interfaces:

CustomCampaignEntityPlugin

Direct Known Subclasses:

AbyssalLightEntityPlugin, BaseCampaignObjectivePlugin, CargoPodsEntityPlugin, CryosleeperEntityPlugin, DerelictShipEntityPlugin, ExampleCustomEntityPlugin, ExplosionEntityPlugin, FusionLampEntityPlugin, GateEntityPlugin, GateHaulerEntityPlugin, HiddenCacheEntityPlugin, SlipstreamEntityPlugin, SlipstreamEntityPlugin2, SupplyCacheEntityPlugin, TurbulenceEntityPlugin, WarningBeaconEntityPlugin

public class BaseCustomEntityPlugin
extends java.lang.Object
implements CustomCampaignEntityPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected SectorEntityToken	entity

Constructor Summary

Constructors

Constructor and Description
BaseCustomEntityPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	advance(float amount)
void	appendToCampaignTooltip(TooltipMakerAPI tooltip, SectorEntityToken.VisibilityLevel level)
void	createMapTooltip(TooltipMakerAPI tooltip, boolean expanded)
float	getMapTooltipWidth()
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, java.lang.Object pluginParams)
boolean	isMapTooltipExpandable()
void	render(CampaignEngineLayers layer, ViewportAPI viewport) Should only render for specified layer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entity

protected SectorEntityToken entity

Constructor Detail

BaseCustomEntityPlugin

public BaseCustomEntityPlugin()

Method Detail

init

public void init(SectorEntityToken entity,
        java.lang.Object pluginParams)

Specified by:

init in interface CustomCampaignEntityPlugin

advance

public void advance(float amount)

Specified by:

advance in interface CustomCampaignEntityPlugin

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

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

hasCustomMapTooltip

public boolean hasCustomMapTooltip()

Specified by:

hasCustomMapTooltip in interface CustomCampaignEntityPlugin

getMapTooltipWidth

public float getMapTooltipWidth()

Specified by:

getMapTooltipWidth in interface CustomCampaignEntityPlugin

isMapTooltipExpandable

public boolean isMapTooltipExpandable()

Specified by:

isMapTooltipExpandable in interface CustomCampaignEntityPlugin

createMapTooltip

public void createMapTooltip(TooltipMakerAPI tooltip,
                    boolean expanded)

Specified by:

createMapTooltip in interface CustomCampaignEntityPlugin

appendToCampaignTooltip

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

Specified by:

appendToCampaignTooltip in interface CustomCampaignEntityPlugin