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

Class SlipstreamTerrainPlugin

java.lang.Object

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

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

All Implemented Interfaces:

CampaignTerrainPlugin

public class SlipstreamTerrainPlugin
extends BaseTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlipstreamTerrainPlugin.Stream
static class	SlipstreamTerrainPlugin.StreamPoint

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<SectorEntityToken,SlipstreamTerrainPlugin.StreamPoint>	containsCache
protected TimeoutTracker<SectorEntityToken>	disrupted
static java.lang.String	LOCATION_SLIPSTREAM_KEY
static float	MAX_POINT_DIST
static float	MIN_POINT_DIST
protected java.util.Map<SectorEntityToken,SlipstreamTerrainPlugin.Stream>	streams
static float	WIDTH_GROWTH_PER_DAY

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
SlipstreamTerrainPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
void	disrupt(CampaignFleetAPI fleet, float dur)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
TimeoutTracker<SectorEntityToken>	getDisrupted()
java.lang.String	getEffectCategory()
java.lang.String	getNameForTooltip()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
static CampaignTerrainAPI	getSlipstream(LocationAPI location)
static SlipstreamTerrainPlugin	getSlipstreamPlugin(LocationAPI location)
protected SlipstreamTerrainPlugin.Stream	getStream(SectorEntityToken key)
java.lang.String	getTerrainName()
float	getTooltipWidth()
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isTooltipExpandable()
boolean	stacksWithSelf()

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, hasAIFlag, hasMapIcon, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, render, renderOnMap, renderOnMapAbove, renderOnRadar, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, shouldPlayLoopFour, shouldPlayLoopOne, shouldPlayLoopThree, shouldPlayLoopTwo

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_SLIPSTREAM_KEY

public static final java.lang.String LOCATION_SLIPSTREAM_KEY

See Also:

Constant Field Values

MIN_POINT_DIST

public static final float MIN_POINT_DIST

See Also:

Constant Field Values

MAX_POINT_DIST

public static final float MAX_POINT_DIST

See Also:

Constant Field Values

WIDTH_GROWTH_PER_DAY

public static final float WIDTH_GROWTH_PER_DAY

See Also:

Constant Field Values

streams

protected java.util.Map<SectorEntityToken,SlipstreamTerrainPlugin.Stream> streams

containsCache

protected transient java.util.Map<SectorEntityToken,SlipstreamTerrainPlugin.StreamPoint> containsCache

disrupted

protected TimeoutTracker<SectorEntityToken> disrupted

Constructor Detail

SlipstreamTerrainPlugin

public SlipstreamTerrainPlugin()

Method Detail

getSlipstream

public static CampaignTerrainAPI getSlipstream(LocationAPI location)

getSlipstreamPlugin

public static SlipstreamTerrainPlugin getSlipstreamPlugin(LocationAPI location)

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTerrain

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

getDisrupted

public TimeoutTracker<SectorEntityToken> getDisrupted()

disrupt

public void disrupt(CampaignFleetAPI fleet,
                    float dur)

getStream

protected SlipstreamTerrainPlugin.Stream getStream(SectorEntityToken key)

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

Overrides:

applyEffect 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

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:

stacksWithSelf

public boolean stacksWithSelf()

Overrides:

stacksWithSelf 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:

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

Overrides:

createTooltip 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