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

Class MagneticFieldTerrainPlugin

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.MagneticFieldTerrainPlugin

All Implemented Interfaces:

CampaignTerrainPlugin, AuroraRenderer.AuroraRendererDelegate, FlareManager.FlareManagerDelegate

public class MagneticFieldTerrainPlugin
extends BaseRingTerrain
implements AuroraRenderer.AuroraRendererDelegate, FlareManager.FlareManagerDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MagneticFieldTerrainPlugin.MagneticFieldParams

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

BaseRingTerrain.RingParams

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	color
static final float	DETECTED_MULT
static final float	DETECTED_MULT_AURORA
protected FlareManager	flareManager
protected MagneticFieldTerrainPlugin.MagneticFieldParams	params
protected AuroraRenderer	renderer
static final float	SENSOR_MULT_AURORA
protected SpriteAPI	texture

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	Description
MagneticFieldTerrainPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
boolean	canPlayerHoldStationIn()
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
EnumSet<CampaignEngineLayers>	getActiveLayers()	Set of layers can not change.
protected float	getAdjustedMult(CampaignFleetAPI fleet, float baseMult)
float	getAuroraAlphaMultForAngle(float angle)
float	getAuroraBandWidthInTexture()
RangeBlockerUtil	getAuroraBlocker()
org.lwjgl.util.vector.Vector2f	getAuroraCenterLoc()
Color	getAuroraColorForAngle(float angle)
float	getAuroraInnerOffsetMult(float angle)
float	getAuroraInnerRadius()
float	getAuroraOuterRadius()
float	getAuroraShortenMult(float angle)
float	getAuroraTexPerSegmentMult()
SpriteAPI	getAuroraTexture()
float	getAuroraThicknessFlat(float angle)
float	getAuroraThicknessMult(float angle)
String	getEffectCategory()
float	getFlareArcMax()
float	getFlareArcMin()
SectorEntityToken	getFlareCenterEntity()
List<Color>	getFlareColorRange()
float	getFlareExtraLengthFlatMax()
float	getFlareExtraLengthFlatMin()
float	getFlareExtraLengthMultMax()
float	getFlareExtraLengthMultMin()
float	getFlareFadeInMax()
float	getFlareFadeInMin()
float	getFlareFadeOutMax()
float	getFlareFadeOutMin()
FlareManager	getFlareManager()
int	getFlareMaxSmallCount()
int	getFlareMinSmallCount()
float	getFlareOccurrenceAngle()
float	getFlareOccurrenceArc()
float	getFlareProbability()
float	getFlareShortenFlatModMax()
float	getFlareShortenFlatModMin()
float	getFlareSkipLargeProbability()
float	getFlareSmallArcMax()
float	getFlareSmallArcMin()
float	getFlareSmallExtraLengthFlatMax()
float	getFlareSmallExtraLengthFlatMin()
float	getFlareSmallExtraLengthMultMax()
float	getFlareSmallExtraLengthMultMin()
float	getFlareSmallFadeInMax()
float	getFlareSmallFadeInMin()
float	getFlareSmallFadeOutMax()
float	getFlareSmallFadeOutMin()
float	getFlareSmallShortenFlatModMax()
float	getFlareSmallShortenFlatModMin()
Color	getNameColor()
String	getNameForTooltip()
MagneticFieldTerrainPlugin.MagneticFieldParams	getParams()
AuroraRenderer	getRenderer()
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
String	getTerrainName()
float	getTooltipWidth()
boolean	hasAIFlag(Object flag)
boolean	hasTooltip()
void	init(String terrainId, SectorEntityToken entity, Object param)
boolean	isTooltipExpandable()
protected Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
protected boolean	shouldPlayLoopOne()
protected boolean	shouldPlayLoopTwo()

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

containsEntity, getMaxEffectRadius, getMaxRadiusForContains, getMinEffectRadius, getMinRadiusForContains, getNameAOrAn, getOptimalEffectRadius, getProximitySoundFactor, getRelatedEntity, getRingParams, renderOnMap, renderOnMapAbove

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

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

Methods inherited from class java.lang.Object

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

Field Details

SENSOR_MULT_AURORA

public static final float SENSOR_MULT_AURORA

See Also:

• Constant Field Values

DETECTED_MULT_AURORA

public static final float DETECTED_MULT_AURORA

See Also:

• Constant Field Values

DETECTED_MULT

public static final float DETECTED_MULT

See Also:

• Constant Field Values

texture

protected transient SpriteAPI texture

color

protected transient Color color

renderer

protected AuroraRenderer renderer

params

protected MagneticFieldTerrainPlugin.MagneticFieldParams params

flareManager

protected FlareManager flareManager

Constructor Details

MagneticFieldTerrainPlugin

public MagneticFieldTerrainPlugin()

Method Details

getParams

public MagneticFieldTerrainPlugin.MagneticFieldParams getParams()

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseRingTerrain

getNameForTooltip

public String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

readResolve

protected Object readResolve()

Overrides:

readResolve in class BaseRingTerrain

getActiveLayers

public EnumSet<CampaignEngineLayers> getActiveLayers()

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Overrides:

getActiveLayers in class BaseRingTerrain

Returns:

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseRingTerrain

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 BaseRingTerrain

Returns:

shouldPlayLoopOne

protected boolean shouldPlayLoopOne()

Overrides:

shouldPlayLoopOne in class BaseTerrain

shouldPlayLoopTwo

protected boolean shouldPlayLoopTwo()

Overrides:

shouldPlayLoopTwo in class BaseTerrain

applyEffect

public void applyEffect(SectorEntityToken entity,
 float days)

Overrides:

applyEffect in class BaseTerrain

getAdjustedMult

protected float getAdjustedMult(CampaignFleetAPI fleet,
 float baseMult)

containsPoint

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

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseRingTerrain

getNameColor

public Color getNameColor()

Specified by:

getNameColor in interface CampaignTerrainPlugin

Overrides:

getNameColor in class BaseTerrain

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 String getTerrainName()

Specified by:

getTerrainName in interface CampaignTerrainPlugin

Overrides:

getTerrainName in class BaseTerrain

getEffectCategory

public String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

getAuroraAlphaMultForAngle

public float getAuroraAlphaMultForAngle(float angle)

Specified by:

getAuroraAlphaMultForAngle in interface AuroraRenderer.AuroraRendererDelegate

getAuroraBandWidthInTexture

public float getAuroraBandWidthInTexture()

Specified by:

getAuroraBandWidthInTexture in interface AuroraRenderer.AuroraRendererDelegate

getAuroraCenterLoc

public org.lwjgl.util.vector.Vector2f getAuroraCenterLoc()

Specified by:

getAuroraCenterLoc in interface AuroraRenderer.AuroraRendererDelegate

getAuroraColorForAngle

public Color getAuroraColorForAngle(float angle)

Specified by:

getAuroraColorForAngle in interface AuroraRenderer.AuroraRendererDelegate

getAuroraInnerRadius

public float getAuroraInnerRadius()

Specified by:

getAuroraInnerRadius in interface AuroraRenderer.AuroraRendererDelegate

getAuroraOuterRadius

public float getAuroraOuterRadius()

Specified by:

getAuroraOuterRadius in interface AuroraRenderer.AuroraRendererDelegate

getAuroraShortenMult

public float getAuroraShortenMult(float angle)

Specified by:

getAuroraShortenMult in interface AuroraRenderer.AuroraRendererDelegate

getAuroraInnerOffsetMult

public float getAuroraInnerOffsetMult(float angle)

Specified by:

getAuroraInnerOffsetMult in interface AuroraRenderer.AuroraRendererDelegate

getAuroraTexPerSegmentMult

public float getAuroraTexPerSegmentMult()

Specified by:

getAuroraTexPerSegmentMult in interface AuroraRenderer.AuroraRendererDelegate

getAuroraTexture

public SpriteAPI getAuroraTexture()

Specified by:

getAuroraTexture in interface AuroraRenderer.AuroraRendererDelegate

getAuroraThicknessFlat

public float getAuroraThicknessFlat(float angle)

Specified by:

getAuroraThicknessFlat in interface AuroraRenderer.AuroraRendererDelegate

getAuroraThicknessMult

public float getAuroraThicknessMult(float angle)

Specified by:

getAuroraThicknessMult in interface AuroraRenderer.AuroraRendererDelegate

getFlareArcMax

public float getFlareArcMax()

Specified by:

getFlareArcMax in interface FlareManager.FlareManagerDelegate

getFlareArcMin

public float getFlareArcMin()

Specified by:

getFlareArcMin in interface FlareManager.FlareManagerDelegate

getFlareColorRange

public List<Color> getFlareColorRange()

Specified by:

getFlareColorRange in interface FlareManager.FlareManagerDelegate

getFlareExtraLengthFlatMax

public float getFlareExtraLengthFlatMax()

Specified by:

getFlareExtraLengthFlatMax in interface FlareManager.FlareManagerDelegate

getFlareExtraLengthFlatMin

public float getFlareExtraLengthFlatMin()

Specified by:

getFlareExtraLengthFlatMin in interface FlareManager.FlareManagerDelegate

getFlareExtraLengthMultMax

public float getFlareExtraLengthMultMax()

Specified by:

getFlareExtraLengthMultMax in interface FlareManager.FlareManagerDelegate

getFlareExtraLengthMultMin

public float getFlareExtraLengthMultMin()

Specified by:

getFlareExtraLengthMultMin in interface FlareManager.FlareManagerDelegate

getFlareFadeInMax

public float getFlareFadeInMax()

Specified by:

getFlareFadeInMax in interface FlareManager.FlareManagerDelegate

getFlareFadeInMin

public float getFlareFadeInMin()

Specified by:

getFlareFadeInMin in interface FlareManager.FlareManagerDelegate

getFlareFadeOutMax

public float getFlareFadeOutMax()

Specified by:

getFlareFadeOutMax in interface FlareManager.FlareManagerDelegate

getFlareFadeOutMin

public float getFlareFadeOutMin()

Specified by:

getFlareFadeOutMin in interface FlareManager.FlareManagerDelegate

getFlareOccurrenceAngle

public float getFlareOccurrenceAngle()

Specified by:

getFlareOccurrenceAngle in interface FlareManager.FlareManagerDelegate

getFlareOccurrenceArc

public float getFlareOccurrenceArc()

Specified by:

getFlareOccurrenceArc in interface FlareManager.FlareManagerDelegate

getFlareProbability

public float getFlareProbability()

Specified by:

getFlareProbability in interface FlareManager.FlareManagerDelegate

getFlareSmallArcMax

public float getFlareSmallArcMax()

Specified by:

getFlareSmallArcMax in interface FlareManager.FlareManagerDelegate

getFlareSmallArcMin

public float getFlareSmallArcMin()

Specified by:

getFlareSmallArcMin in interface FlareManager.FlareManagerDelegate

getFlareSmallExtraLengthFlatMax

public float getFlareSmallExtraLengthFlatMax()

Specified by:

getFlareSmallExtraLengthFlatMax in interface FlareManager.FlareManagerDelegate

getFlareSmallExtraLengthFlatMin

public float getFlareSmallExtraLengthFlatMin()

Specified by:

getFlareSmallExtraLengthFlatMin in interface FlareManager.FlareManagerDelegate

getFlareSmallExtraLengthMultMax

public float getFlareSmallExtraLengthMultMax()

Specified by:

getFlareSmallExtraLengthMultMax in interface FlareManager.FlareManagerDelegate

getFlareSmallExtraLengthMultMin

public float getFlareSmallExtraLengthMultMin()

Specified by:

getFlareSmallExtraLengthMultMin in interface FlareManager.FlareManagerDelegate

getFlareSmallFadeInMax

public float getFlareSmallFadeInMax()

Specified by:

getFlareSmallFadeInMax in interface FlareManager.FlareManagerDelegate

getFlareSmallFadeInMin

public float getFlareSmallFadeInMin()

Specified by:

getFlareSmallFadeInMin in interface FlareManager.FlareManagerDelegate

getFlareSmallFadeOutMax

public float getFlareSmallFadeOutMax()

Specified by:

getFlareSmallFadeOutMax in interface FlareManager.FlareManagerDelegate

getFlareSmallFadeOutMin

public float getFlareSmallFadeOutMin()

Specified by:

getFlareSmallFadeOutMin in interface FlareManager.FlareManagerDelegate

getFlareShortenFlatModMax

public float getFlareShortenFlatModMax()

Specified by:

getFlareShortenFlatModMax in interface FlareManager.FlareManagerDelegate

getFlareShortenFlatModMin

public float getFlareShortenFlatModMin()

Specified by:

getFlareShortenFlatModMin in interface FlareManager.FlareManagerDelegate

getFlareSmallShortenFlatModMax

public float getFlareSmallShortenFlatModMax()

Specified by:

getFlareSmallShortenFlatModMax in interface FlareManager.FlareManagerDelegate

getFlareSmallShortenFlatModMin

public float getFlareSmallShortenFlatModMin()

Specified by:

getFlareSmallShortenFlatModMin in interface FlareManager.FlareManagerDelegate

getFlareMaxSmallCount

public int getFlareMaxSmallCount()

Specified by:

getFlareMaxSmallCount in interface FlareManager.FlareManagerDelegate

getFlareMinSmallCount

public int getFlareMinSmallCount()

Specified by:

getFlareMinSmallCount in interface FlareManager.FlareManagerDelegate

getFlareSkipLargeProbability

public float getFlareSkipLargeProbability()

Specified by:

getFlareSkipLargeProbability in interface FlareManager.FlareManagerDelegate

getFlareCenterEntity

public SectorEntityToken getFlareCenterEntity()

Specified by:

getFlareCenterEntity in interface FlareManager.FlareManagerDelegate

hasAIFlag

public boolean hasAIFlag(Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

canPlayerHoldStationIn

public boolean canPlayerHoldStationIn()

Specified by:

canPlayerHoldStationIn in interface CampaignTerrainPlugin

Overrides:

canPlayerHoldStationIn in class BaseTerrain

getAuroraBlocker

public RangeBlockerUtil getAuroraBlocker()

Specified by:

getAuroraBlocker in interface AuroraRenderer.AuroraRendererDelegate

getRenderer

public AuroraRenderer getRenderer()

getFlareManager

public FlareManager getFlareManager()