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

Class BaseTerrain

java.lang.Object

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

All Implemented Interfaces:

CampaignTerrainPlugin

Direct Known Subclasses:

BaseRingTerrain, BaseTiledTerrain, SlipstreamTerrainPlugin, SlipstreamTerrainPlugin2, WavefrontTerrainPlugin

public class BaseTerrain
extends java.lang.Object
implements CampaignTerrainPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected SectorEntityToken	entity
static float	EXTRA_SOUND_RADIUS
protected java.lang.String	name
static java.lang.String	TERRAIN_LOCK_KEY
protected java.lang.String	terrainId

Constructor Summary

Constructors

Constructor and Description
BaseTerrain()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
boolean	canPlayerHoldStationIn()
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
protected void	createCombatSection(TooltipMakerAPI tooltip, boolean expanded)
protected void	createFirstSection(TooltipMakerAPI tooltip, boolean expanded)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
protected void	createTravelSection(TooltipMakerAPI tooltip, boolean expanded, float firstPad)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
java.lang.String	getEffectCategory()
SectorEntityToken	getEntity()
protected float	getExtraSoundRadius()
java.lang.String	getIconSpriteName()
protected float	getLoopFourPitch()
protected float	getLoopFourVolume()
protected float	getLoopOnePitch()
protected float	getLoopOneVolume()
protected float	getLoopThreePitch()
protected float	getLoopThreeVolume()
protected float	getLoopTwoPitch()
protected float	getLoopTwoVolume()
float	getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
float	getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
java.lang.String	getModId()
java.lang.String	getNameAOrAn()
java.awt.Color	getNameColor()
java.lang.String	getNameForTooltip()
float	getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
float	getProximitySoundFactor()
SectorEntityToken	getRelatedEntity()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
TerrainSpecAPI	getSpec()
java.lang.String	getTerrainId()
java.lang.String	getTerrainName()
float	getTooltipWidth()
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasAIFlag(java.lang.Object flag, CampaignFleetAPI fleet)
boolean	hasMapIcon()
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isPreventedFromAffecting(SectorEntityToken other)
boolean	isTooltipExpandable()
protected void	preventOtherTerrainFromAffecting(SectorEntityToken other)
protected void	preventOtherTerrainFromAffecting(SectorEntityToken other, float dur)
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult) First pass.
void	renderOnMapAbove(float factor, float alphaMult) Second pass.
void	renderOnRadar(org.lwjgl.util.vector.Vector2f radarCenter, float factor, float alphaMult)
void	setEntity(SectorEntityToken entity)
void	setTerrainId(java.lang.String id)
void	setTerrainName(java.lang.String name)
protected boolean	shouldCheckFleetsToApplyEffect()
protected boolean	shouldPlayLoopFour()
protected boolean	shouldPlayLoopOne()
protected boolean	shouldPlayLoopThree()
protected boolean	shouldPlayLoopTwo()
boolean	stacksWithSelf()

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_SOUND_RADIUS

public static final float EXTRA_SOUND_RADIUS

See Also:

Constant Field Values

entity

protected SectorEntityToken entity

terrainId

protected java.lang.String terrainId

name

protected java.lang.String name

TERRAIN_LOCK_KEY

public static java.lang.String TERRAIN_LOCK_KEY

Constructor Detail

BaseTerrain

public BaseTerrain()

Method Detail

init

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

Specified by:

init in interface CampaignTerrainPlugin

getIconSpriteName

public java.lang.String getIconSpriteName()

Specified by:

getIconSpriteName in interface CampaignTerrainPlugin

getRelatedEntity

public SectorEntityToken getRelatedEntity()

getEntity

public SectorEntityToken getEntity()

setEntity

public void setEntity(SectorEntityToken entity)

Specified by:

setEntity in interface CampaignTerrainPlugin

getTerrainId

public java.lang.String getTerrainId()

Specified by:

getTerrainId in interface CampaignTerrainPlugin

setTerrainId

public void setTerrainId(java.lang.String id)

Specified by:

setTerrainId in interface CampaignTerrainPlugin

shouldCheckFleetsToApplyEffect

protected boolean shouldCheckFleetsToApplyEffect()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

getExtraSoundRadius

protected float getExtraSoundRadius()

getEffectCategory

public java.lang.String getEffectCategory()

containsEntity

public boolean containsEntity(SectorEntityToken other)

Specified by:

containsEntity in interface CampaignTerrainPlugin

containsPoint

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

Specified by:

containsPoint in interface CampaignTerrainPlugin

stacksWithSelf

public boolean stacksWithSelf()

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

getProximitySoundFactor

public float getProximitySoundFactor()

getModId

public java.lang.String getModId()

getActiveLayers

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

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Returns:

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

Returns:

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

renderOnMap

public void renderOnMap(float factor,
                        float alphaMult)

Description copied from interface: CampaignTerrainPlugin

First pass.

Specified by:

renderOnMap in interface CampaignTerrainPlugin

Parameters:

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

renderOnMapAbove

public void renderOnMapAbove(float factor,
                             float alphaMult)

Description copied from interface: CampaignTerrainPlugin

Second pass.

Specified by:

renderOnMapAbove in interface CampaignTerrainPlugin

Parameters:

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

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

createFirstSection

protected void createFirstSection(TooltipMakerAPI tooltip,
                                  boolean expanded)

createTravelSection

protected void createTravelSection(TooltipMakerAPI tooltip,
                                   boolean expanded,
                                   float firstPad)

createCombatSection

protected void createCombatSection(TooltipMakerAPI tooltip,
                                   boolean expanded)

shouldPlayLoopOne

protected boolean shouldPlayLoopOne()

shouldPlayLoopTwo

protected boolean shouldPlayLoopTwo()

shouldPlayLoopThree

protected boolean shouldPlayLoopThree()

shouldPlayLoopFour

protected boolean shouldPlayLoopFour()

getLoopOnePitch

protected float getLoopOnePitch()

getLoopOneVolume

protected float getLoopOneVolume()

getLoopTwoPitch

protected float getLoopTwoPitch()

getLoopTwoVolume

protected float getLoopTwoVolume()

getLoopThreePitch

protected float getLoopThreePitch()

getLoopThreeVolume

protected float getLoopThreeVolume()

getLoopFourPitch

protected float getLoopFourPitch()

getLoopFourVolume

protected float getLoopFourVolume()

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface CampaignTerrainPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface CampaignTerrainPlugin

getTerrainName

public java.lang.String getTerrainName()

Specified by:

getTerrainName in interface CampaignTerrainPlugin

getNameAOrAn

public java.lang.String getNameAOrAn()

Specified by:

getNameAOrAn in interface CampaignTerrainPlugin

setTerrainName

public void setTerrainName(java.lang.String name)

Specified by:

setTerrainName in interface CampaignTerrainPlugin

getNameColor

public java.awt.Color getNameColor()

Specified by:

getNameColor in interface CampaignTerrainPlugin

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag,
                         CampaignFleetAPI fleet)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

getMaxEffectRadius

public float getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMaxEffectRadius in interface CampaignTerrainPlugin

Returns:

getMinEffectRadius

public float getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMinEffectRadius in interface CampaignTerrainPlugin

Returns:

getOptimalEffectRadius

public float getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getOptimalEffectRadius in interface CampaignTerrainPlugin

Returns:

hasMapIcon

public boolean hasMapIcon()

Specified by:

hasMapIcon in interface CampaignTerrainPlugin

getSpec

public TerrainSpecAPI getSpec()

Specified by:

getSpec in interface CampaignTerrainPlugin

canPlayerHoldStationIn

public boolean canPlayerHoldStationIn()

Specified by:

canPlayerHoldStationIn in interface CampaignTerrainPlugin

renderOnRadar

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

Specified by:

renderOnRadar in interface CampaignTerrainPlugin

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

isPreventedFromAffecting

public boolean isPreventedFromAffecting(SectorEntityToken other)

preventOtherTerrainFromAffecting

protected void preventOtherTerrainFromAffecting(SectorEntityToken other)

preventOtherTerrainFromAffecting

protected void preventOtherTerrainFromAffecting(SectorEntityToken other,
                                                float dur)