com.fs.starfarer.api.impl.campaign

Class ExplosionEntityPlugin

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.ExplosionEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class ExplosionEntityPlugin
extends BaseCustomEntityPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExplosionEntityPlugin.ExplosionFleetDamage
static class	ExplosionEntityPlugin.ExplosionParams
static class	ExplosionEntityPlugin.ParticleData

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashSet<java.lang.String>	damagedAlready
protected float	maxParticleSize
protected ExplosionEntityPlugin.ExplosionParams	params
protected java.util.List<ExplosionEntityPlugin.ParticleData>	particles
protected float	shockwaveAccel
protected float	shockwaveDuration
protected float	shockwaveRadius
protected float	shockwaveSpeed
protected float	shockwaveWidth
protected SpriteAPI	sprite

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

entity

Constructor Summary

Constructors

Constructor and Description
ExplosionEntityPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyDamageToFleet(CampaignFleetAPI fleet, float damageMult)
void	applyDamageToFleets()
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.

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

params

protected ExplosionEntityPlugin.ExplosionParams params

particles

protected java.util.List<ExplosionEntityPlugin.ParticleData> particles

sprite

protected transient SpriteAPI sprite

shockwaveRadius

protected float shockwaveRadius

shockwaveWidth

protected float shockwaveWidth

shockwaveSpeed

protected float shockwaveSpeed

shockwaveDuration

protected float shockwaveDuration

shockwaveAccel

protected float shockwaveAccel

maxParticleSize

protected float maxParticleSize

damagedAlready

protected java.util.LinkedHashSet<java.lang.String> damagedAlready

Constructor Detail

ExplosionEntityPlugin

public ExplosionEntityPlugin()

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.

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

applyDamageToFleets

public void applyDamageToFleets()

applyDamageToFleet

public void applyDamageToFleet(CampaignFleetAPI fleet,
                               float damageMult)