com.fs.starfarer.api.impl.campaign

Class CargoPodsEntityPlugin

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.CargoPodsEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class CargoPodsEntityPlugin
extends BaseCustomEntityPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected float	elapsed
protected float	extraDays
protected GenericFieldItemManager	manager
protected float	maxDays
protected java.lang.Boolean	neverExpire

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

entity

Constructor Summary

Constructors

Constructor and Description
CargoPodsEntityPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
static float	computeDetectionRange(float radius)
float	getDaysLeft()
float	getElapsed()
float	getExtraDays()
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)
java.lang.Boolean	isNeverExpire()
void	render(CampaignEngineLayers layer, ViewportAPI viewport) Should only render for specified layer.
void	setElapsed(float elapsed)
void	setExtraDays(float extraDays)
void	setNeverExpire(java.lang.Boolean neverExpire)
void	updateBaseMaxDays()

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

manager

protected transient GenericFieldItemManager manager

elapsed

protected float elapsed

maxDays

protected float maxDays

extraDays

protected float extraDays

neverExpire

protected java.lang.Boolean neverExpire

Constructor Detail

CargoPodsEntityPlugin

public CargoPodsEntityPlugin()

Method Detail

computeDetectionRange

public static float computeDetectionRange(float radius)

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.

updateBaseMaxDays

public void updateBaseMaxDays()

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

setNeverExpire

public void setNeverExpire(java.lang.Boolean neverExpire)

isNeverExpire

public java.lang.Boolean isNeverExpire()

getDaysLeft

public float getDaysLeft()

getElapsed

public float getElapsed()

setElapsed

public void setElapsed(float elapsed)

getExtraDays

public float getExtraDays()

setExtraDays

public void setExtraDays(float extraDays)