com.fs.starfarer.api.impl.campaign.velfield

Class TurbulenceEntityPlugin

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.velfield.TurbulenceEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class TurbulenceEntityPlugin
extends BaseCustomEntityPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TurbulenceEntityPlugin.ParticleData
static class	TurbulenceEntityPlugin.PointParticle

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TurbulenceEntityPlugin.ParticleData>	darkParticles
protected float	distanceTravelled
protected VelocityField	field
protected int	frame
protected java.util.List<TurbulenceEntityPlugin.ParticleData>	particles
protected java.util.List<TurbulenceEntityPlugin.PointParticle>	testParticles

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

entity

Constructor Summary

Constructors

Constructor and Description
TurbulenceEntityPlugin()

Method Summary

Modifier and Type	Method and Description
void	addTestParticle(org.lwjgl.util.vector.Vector2f loc, java.awt.Color color, float size, float mass, float dur)
void	addTexturedParticle(org.lwjgl.util.vector.Vector2f loc, java.awt.Color color, float mass, float size, float endSizeMult, float durIn, float durOut)
void	advance(float amount)
VelocityField	getField()
java.awt.Color	getRandomColor()
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.
void	renderTextureParticles(CampaignEngineLayers layer, ViewportAPI viewport)
void	setField(VelocityField field)

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

particles

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

darkParticles

protected java.util.List<TurbulenceEntityPlugin.ParticleData> darkParticles

field

protected VelocityField field

testParticles

protected java.util.List<TurbulenceEntityPlugin.PointParticle> testParticles

frame

protected int frame

distanceTravelled

protected float distanceTravelled

Constructor Detail

TurbulenceEntityPlugin

public TurbulenceEntityPlugin()

Method Detail

getField

public VelocityField getField()

setField

public void setField(VelocityField field)

init

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

Specified by:

init in interface CustomCampaignEntityPlugin

Overrides:

init in class BaseCustomEntityPlugin

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:

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.

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

renderTextureParticles

public void renderTextureParticles(CampaignEngineLayers layer,
                                   ViewportAPI viewport)

addTestParticle

public void addTestParticle(org.lwjgl.util.vector.Vector2f loc,
                            java.awt.Color color,
                            float size,
                            float mass,
                            float dur)

addTexturedParticle

public void addTexturedParticle(org.lwjgl.util.vector.Vector2f loc,
                                java.awt.Color color,
                                float mass,
                                float size,
                                float endSizeMult,
                                float durIn,
                                float durOut)

getRandomColor

public java.awt.Color getRandomColor()