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

Class SlipstreamTerrainPlugin2

java.lang.Object

com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

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

All Implemented Interfaces:

CampaignTerrainPlugin

public class SlipstreamTerrainPlugin2
extends BaseTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlipstreamTerrainPlugin2.SlipstreamParams2
static class	SlipstreamTerrainPlugin2.SlipstreamParticle
static class	SlipstreamTerrainPlugin2.SlipstreamSegment

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<BoundingBox>	bounds
protected SlipstreamBuilder	builder
protected float	despawnDays
protected float	despawnDelay
protected float	despawnElapsed
protected float[]	despawnNoise
protected boolean	dynamic
protected java.util.List<org.lwjgl.util.vector.Vector2f>	encounterPoints
static java.lang.String	FUEL_USE_MODIFIER_DESC
static float	FUEL_USE_MULT
protected int	lengthDivisor
protected int[]	lengthToIndexMap
static int	MAX_PARTICLES_ADD_PER_FRAME
protected boolean	needsRecompute
protected SlipstreamTerrainPlugin2.SlipstreamParams2	params
protected java.util.List<SlipstreamTerrainPlugin2.SlipstreamParticle>	particles
protected float	playerDesiredYOffset
protected int	playerWasInSlipstreamFramesAgo
static float	RAD_PER_DEG
protected java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment>	segments
protected int	segmentsPerBox
protected float	spawnDays
protected float	spawnElapsed
protected float[]	spawnNoise
protected float	texProgress0
protected float	texProgress1
protected float	texProgress2
protected float	totalLength

Fields inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

entity, EXTRA_SOUND_RADIUS, name, TERRAIN_LOCK_KEY, terrainId

Constructor Summary

Constructors

Constructor and Description
SlipstreamTerrainPlugin2()

Method Summary

Modifier and Type	Method and Description
void	addParticles()
void	addSegment(org.lwjgl.util.vector.Vector2f loc, float width)
void	advance(float amount)
protected void	advanceDespawn(float amount)
protected void	advanceNearbySegments(float amount)
void	advanceParticles(float amount)
protected void	advanceSpawn(float amount)
void	applyEffect(SectorEntityToken other, float days)
void	applyEffectToEntities(float amount)
void	applyEffectToGhost(SectorEntityToken other, float days)
void	applyEffectToWreck(SectorEntityToken other, float days)
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
void	despawn(float despawnDelay, float despawnDays, java.util.Random random)
protected void	doSoundPlayback(float amount)
float	getAbyssalBMult(boolean forMap)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
java.util.List<BoundingBox>	getBounds()
SlipstreamBuilder	getBuilder()
java.lang.String	getEffectCategory()
java.util.List<org.lwjgl.util.vector.Vector2f>	getEncounterPoints()
float	getFaderBrightness(float distAlong)
float	getIntensity(float yOff)
float[]	getLengthAndWidthFractionWithinStream(org.lwjgl.util.vector.Vector2f loc) result[0] = actual distance along the length of the slipstream result[1] = offset along the width of the slipstream, 0 = on center, 1 = on edge along normal, -1 = on edge along negative of normal null if outside stream Assumes rectangular, non-tapered stream
float[]	getLengthAndWidthFractionWithinStream(org.lwjgl.util.vector.Vector2f loc, float extraRangeForCheck, boolean allowOutsideStream, float extraWidthForSegments)
java.lang.String	getNameForTooltip()
org.lwjgl.util.vector.Vector2f	getNormalAt(float lengthAlongStream)
org.lwjgl.util.vector.Vector2f	getNoWobblePointAt(float lengthAlongStream, float offset)
SlipstreamTerrainPlugin2.SlipstreamParams2	getParams()
org.lwjgl.util.vector.Vector2f	getPointAt(float lengthAlongStream, float offset)
java.awt.Color	getRandomColor()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
SlipstreamTerrainPlugin2.SlipstreamSegment	getSegmentForDist(float distAlongStream)
java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment>	getSegments()
java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment>	getSegmentsNear(org.lwjgl.util.vector.Vector2f loc, float range)
java.lang.String	getTerrainName()
float	getTooltipWidth()
float	getTotalLength()
float	getWidth(float distAlong)
float	getWidthBasedSpeedMult(float distAlong)
float	getWobbledWidth(float distAlong)
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object pluginParams)
boolean	isDespawning()
boolean	isDynamic()
boolean	isTooltipExpandable()
protected void	playerNoLongerinSlipstream()
void	recompute()
void	recomputeEncounterPoints()
void	recomputeIfNeeded()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult) First pass.
void	renderOnMap(float factor, float alphaMult, boolean forRadar, org.lwjgl.util.vector.Vector2f radarCenter)
void	renderOnRadar(org.lwjgl.util.vector.Vector2f radarCenter, float factor, float alphaMult)
void	renderSegments(SpriteAPI sprite0, SpriteAPI sprite1, SpriteAPI sprite2, SpriteAPI edge, float alpha, java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments, float extraTX, boolean forMap)
protected void	renderSegmentsForMap(java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments, float factor, float alphaMult, boolean forRadar, float phase)
static org.lwjgl.util.vector.Vector2f	rotateAroundOrigin(org.lwjgl.util.vector.Vector2f v, float cos, float sin)
void	setBuilder(SlipstreamBuilder builder)
void	setDynamic(boolean dynamic)
void	setNeedsRecompute()
protected boolean	shouldCheckFleetsToApplyEffect()
protected boolean	shouldPlayLoopOne()
protected boolean	shouldPlayLoopTwo()
void	spawn(float spawnDays, java.util.Random random)
protected void	updateBoundingBoxes()
void	updateLengthToIndexMap()

Methods inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

canPlayerHoldStationIn, createCombatSection, createFirstSection, createTravelSection, getEntity, getExtraSoundRadius, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getMaxEffectRadius, getMinEffectRadius, getModId, getNameAOrAn, getNameColor, getOptimalEffectRadius, getProximitySoundFactor, getRelatedEntity, getSpec, getTerrainId, hasAIFlag, hasMapIcon, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, renderOnMapAbove, setEntity, setTerrainId, setTerrainName, shouldPlayLoopFour, shouldPlayLoopThree, stacksWithSelf

Methods inherited from class java.lang.Object

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

Field Detail

FUEL_USE_MULT

public static float FUEL_USE_MULT

FUEL_USE_MODIFIER_DESC

public static java.lang.String FUEL_USE_MODIFIER_DESC

MAX_PARTICLES_ADD_PER_FRAME

public static int MAX_PARTICLES_ADD_PER_FRAME

RAD_PER_DEG

public static float RAD_PER_DEG

params

protected SlipstreamTerrainPlugin2.SlipstreamParams2 params

segments

protected java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments

totalLength

protected float totalLength

encounterPoints

protected transient java.util.List<org.lwjgl.util.vector.Vector2f> encounterPoints

particles

protected transient java.util.List<SlipstreamTerrainPlugin2.SlipstreamParticle> particles

lengthToIndexMap

protected transient int[] lengthToIndexMap

lengthDivisor

protected transient int lengthDivisor

needsRecompute

protected boolean needsRecompute

bounds

protected transient java.util.List<BoundingBox> bounds

segmentsPerBox

protected int segmentsPerBox

texProgress0

protected float texProgress0

texProgress1

protected float texProgress1

texProgress2

protected float texProgress2

despawnNoise

protected float[] despawnNoise

despawnDelay

protected float despawnDelay

despawnDays

protected float despawnDays

despawnElapsed

protected float despawnElapsed

spawnNoise

protected float[] spawnNoise

spawnDays

protected float spawnDays

spawnElapsed

protected float spawnElapsed

dynamic

protected boolean dynamic

builder

protected transient SlipstreamBuilder builder

playerWasInSlipstreamFramesAgo

protected int playerWasInSlipstreamFramesAgo

playerDesiredYOffset

protected float playerDesiredYOffset

Constructor Detail

SlipstreamTerrainPlugin2

public SlipstreamTerrainPlugin2()

Method Detail

rotateAroundOrigin

public static org.lwjgl.util.vector.Vector2f rotateAroundOrigin(org.lwjgl.util.vector.Vector2f v,
                                                                float cos,
                                                                float sin)

isDespawning

public boolean isDespawning()

spawn

public void spawn(float spawnDays,
                  java.util.Random random)

advanceSpawn

protected void advanceSpawn(float amount)

despawn

public void despawn(float despawnDelay,
                    float despawnDays,
                    java.util.Random random)

advanceDespawn

protected void advanceDespawn(float amount)

setNeedsRecompute

public void setNeedsRecompute()

updateLengthToIndexMap

public void updateLengthToIndexMap()

getSegmentForDist

public SlipstreamTerrainPlugin2.SlipstreamSegment getSegmentForDist(float distAlongStream)

addSegment

public void addSegment(org.lwjgl.util.vector.Vector2f loc,
                       float width)

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTerrain

getRenderRange

public float getRenderRange()

Description copied from interface: CampaignTerrainPlugin

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 CampaignTerrainPlugin

Overrides:

getRenderRange in class BaseTerrain

Returns:

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

recomputeIfNeeded

public void recomputeIfNeeded()

recompute

public void recompute()

updateBoundingBoxes

protected void updateBoundingBoxes()

advanceNearbySegments

protected void advanceNearbySegments(float amount)

addParticles

public void addParticles()

advanceParticles

public void advanceParticles(float amount)

getWidthBasedSpeedMult

public float getWidthBasedSpeedMult(float distAlong)

getWidth

public float getWidth(float distAlong)

getWobbledWidth

public float getWobbledWidth(float distAlong)

getIntensity

public float getIntensity(float yOff)

getFaderBrightness

public float getFaderBrightness(float distAlong)

getBuilder

public SlipstreamBuilder getBuilder()

setBuilder

public void setBuilder(SlipstreamBuilder builder)

getParams

public SlipstreamTerrainPlugin2.SlipstreamParams2 getParams()

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTerrain

getAbyssalBMult

public float getAbyssalBMult(boolean forMap)

renderSegments

public void renderSegments(SpriteAPI sprite0,
                           SpriteAPI sprite1,
                           SpriteAPI sprite2,
                           SpriteAPI edge,
                           float alpha,
                           java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments,
                           float extraTX,
                           boolean forMap)

getRandomColor

public java.awt.Color getRandomColor()

getTotalLength

public float getTotalLength()

getLengthAndWidthFractionWithinStream

public float[] getLengthAndWidthFractionWithinStream(org.lwjgl.util.vector.Vector2f loc)

result[0] = actual distance along the length of the slipstream result[1] = offset along the width of the slipstream, 0 = on center, 1 = on edge along normal, -1 = on edge along negative of normal null if outside stream Assumes rectangular, non-tapered stream

Parameters:

loc -

Returns:

getLengthAndWidthFractionWithinStream

public float[] getLengthAndWidthFractionWithinStream(org.lwjgl.util.vector.Vector2f loc,
                                                     float extraRangeForCheck,
                                                     boolean allowOutsideStream,
                                                     float extraWidthForSegments)

applyEffectToEntities

public void applyEffectToEntities(float amount)

playerNoLongerinSlipstream

protected void playerNoLongerinSlipstream()

applyEffect

public void applyEffect(SectorEntityToken other,
                        float days)

Overrides:

applyEffect in class BaseTerrain

applyEffectToGhost

public void applyEffectToGhost(SectorEntityToken other,
                               float days)

applyEffectToWreck

public void applyEffectToWreck(SectorEntityToken other,
                               float days)

getPointAt

public org.lwjgl.util.vector.Vector2f getPointAt(float lengthAlongStream,
                                                 float offset)

getNoWobblePointAt

public org.lwjgl.util.vector.Vector2f getNoWobblePointAt(float lengthAlongStream,
                                                         float offset)

getNormalAt

public org.lwjgl.util.vector.Vector2f getNormalAt(float lengthAlongStream)

getSegmentsNear

public java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> getSegmentsNear(org.lwjgl.util.vector.Vector2f loc,
                                                                                  float range)

shouldCheckFleetsToApplyEffect

protected boolean shouldCheckFleetsToApplyEffect()

Overrides:

shouldCheckFleetsToApplyEffect in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

containsEntity

public boolean containsEntity(SectorEntityToken other)

Specified by:

containsEntity in interface CampaignTerrainPlugin

Overrides:

containsEntity in class BaseTerrain

containsPoint

public boolean containsPoint(org.lwjgl.util.vector.Vector2f point,
                             float radius)

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseTerrain

getBounds

public java.util.List<BoundingBox> getBounds()

getActiveLayers

public java.util.EnumSet<CampaignEngineLayers> getActiveLayers()

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Overrides:

getActiveLayers in class BaseTerrain

Returns:

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

Overrides:

createTooltip in class BaseTerrain

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface CampaignTerrainPlugin

Overrides:

isTooltipExpandable in class BaseTerrain

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface CampaignTerrainPlugin

Overrides:

getTooltipWidth in class BaseTerrain

getTerrainName

public java.lang.String getTerrainName()

Specified by:

getTerrainName in interface CampaignTerrainPlugin

Overrides:

getTerrainName in class BaseTerrain

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

getEffectCategory

public java.lang.String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

renderOnRadar

public void renderOnRadar(org.lwjgl.util.vector.Vector2f radarCenter,
                          float factor,
                          float alphaMult)

Specified by:

renderOnRadar in interface CampaignTerrainPlugin

Overrides:

renderOnRadar in class BaseTerrain

getSegments

public java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> getSegments()

renderOnMap

public void renderOnMap(float factor,
                        float alphaMult)

Description copied from interface: CampaignTerrainPlugin

First pass.

Specified by:

renderOnMap in interface CampaignTerrainPlugin

Overrides:

renderOnMap in class BaseTerrain

Parameters:

factor - conversion factor from world coordinates to map screen coordinates, including current zoom level.

renderOnMap

public void renderOnMap(float factor,
                        float alphaMult,
                        boolean forRadar,
                        org.lwjgl.util.vector.Vector2f radarCenter)

renderSegmentsForMap

protected void renderSegmentsForMap(java.util.List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments,
                                    float factor,
                                    float alphaMult,
                                    boolean forRadar,
                                    float phase)

doSoundPlayback

protected void doSoundPlayback(float amount)

shouldPlayLoopOne

protected boolean shouldPlayLoopOne()

Overrides:

shouldPlayLoopOne in class BaseTerrain

shouldPlayLoopTwo

protected boolean shouldPlayLoopTwo()

Overrides:

shouldPlayLoopTwo in class BaseTerrain

getEncounterPoints

public java.util.List<org.lwjgl.util.vector.Vector2f> getEncounterPoints()

recomputeEncounterPoints

public void recomputeEncounterPoints()