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

Class DebrisFieldTerrainPlugin

java.lang.Object

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

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

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

All Implemented Interfaces:

CampaignTerrainPlugin

public class DebrisFieldTerrainPlugin
extends BaseRingTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DebrisFieldTerrainPlugin.DebrisFieldParams
static class	DebrisFieldTerrainPlugin.DebrisFieldSource

Nested classes/interfaces inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseRingTerrain

BaseRingTerrain.RingParams

Field Summary

Fields

Modifier and Type	Field and Description
static float	DISSIPATE_DAYS
protected float	elapsed
protected FaderUtil	expander
protected boolean	fadingOut
protected boolean	initedDebris
DebrisFieldTerrainPlugin.DebrisFieldParams	params
protected java.util.List<DebrisPiece>	pieces
protected java.lang.Boolean	scavenged
protected boolean	wasInNonCurrentLocation

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

layers

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

Method Summary

Modifier and Type	Method and Description
protected void	addPiecesToMax()
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
static float	computeDetectionRange(float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
float	getDaysLeft()
java.lang.String	getEffectCategory()
FaderUtil	getExpander()
float	getGlowDaysLeft()
java.lang.String	getIconSpriteName()
protected float	getMaxRadiusForContains()
protected float	getMinRadiusForContains()
java.lang.String	getNameForTooltip()
DebrisFieldTerrainPlugin.DebrisFieldParams	getParams()
float	getPieceGlowProbability()
float	getTooltipWidth()
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
protected void	initDebrisIfNeeded()
boolean	isFadingOut()
boolean	isScavenged()
boolean	isTooltipExpandable()
protected java.lang.Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	setNameForTooltip(java.lang.String nameForTooltip)
void	setScavenged(java.lang.Boolean scavenged)

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

containsEntity, containsPoint, getActiveLayers, getMaxEffectRadius, getMinEffectRadius, getNameAOrAn, getOptimalEffectRadius, getProximitySoundFactor, getRelatedEntity, getRenderRange, getRingParams, renderOnMap, renderOnMapAbove

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

canPlayerHoldStationIn, createCombatSection, createFirstSection, createTravelSection, getEntity, getExtraSoundRadius, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameColor, getSpec, getTerrainId, getTerrainName, hasAIFlag, hasMapIcon, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, renderOnRadar, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, shouldPlayLoopFour, shouldPlayLoopOne, shouldPlayLoopThree, shouldPlayLoopTwo, stacksWithSelf

Methods inherited from class java.lang.Object

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

Field Detail

DISSIPATE_DAYS

public static final float DISSIPATE_DAYS

See Also:

Constant Field Values

pieces

protected transient java.util.List<DebrisPiece> pieces

initedDebris

protected transient boolean initedDebris

params

public DebrisFieldTerrainPlugin.DebrisFieldParams params

fadingOut

protected boolean fadingOut

expander

protected FaderUtil expander

elapsed

protected float elapsed

scavenged

protected java.lang.Boolean scavenged

wasInNonCurrentLocation

protected transient boolean wasInNonCurrentLocation

Constructor Detail

DebrisFieldTerrainPlugin

public DebrisFieldTerrainPlugin()

Method Detail

computeDetectionRange

public static float computeDetectionRange(float radius)

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseRingTerrain

isScavenged

public boolean isScavenged()

setScavenged

public void setScavenged(java.lang.Boolean scavenged)

getParams

public DebrisFieldTerrainPlugin.DebrisFieldParams getParams()

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class BaseRingTerrain

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

getMaxRadiusForContains

protected float getMaxRadiusForContains()

Overrides:

getMaxRadiusForContains in class BaseRingTerrain

getMinRadiusForContains

protected float getMinRadiusForContains()

Overrides:

getMinRadiusForContains in class BaseRingTerrain

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseRingTerrain

addPiecesToMax

protected void addPiecesToMax()

initDebrisIfNeeded

protected void initDebrisIfNeeded()

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

Overrides:

applyEffect in class BaseTerrain

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

setNameForTooltip

public void setNameForTooltip(java.lang.String nameForTooltip)

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

getEffectCategory

public java.lang.String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

getIconSpriteName

public java.lang.String getIconSpriteName()

Specified by:

getIconSpriteName in interface CampaignTerrainPlugin

Overrides:

getIconSpriteName in class BaseTerrain

isFadingOut

public boolean isFadingOut()

getExpander

public FaderUtil getExpander()

getGlowDaysLeft

public float getGlowDaysLeft()

getPieceGlowProbability

public float getPieceGlowProbability()

getDaysLeft

public float getDaysLeft()