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

Class HyperspaceTerrainPlugin

java.lang.Object

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

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

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

All Implemented Interfaces:

CampaignTerrainPlugin

public class HyperspaceTerrainPlugin
extends BaseTiledTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HyperspaceTerrainPlugin.CellState
static class	HyperspaceTerrainPlugin.CellStateTracker
static enum	HyperspaceTerrainPlugin.LocationState

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

BaseTiledTerrain.TileParams, BaseTiledTerrain.TileSample

Field Summary

Fields

Modifier and Type	Field	Description
static Color	ABYSS_BACKGROUND_COLOR
static float	ABYSS_BURN_MULT
static Color	ABYSS_LIGHT_COLOR
static float	ABYSS_MUSIC_SUPPRESSION
static float	ABYSS_NAVIGATION_EFFECT
static Color	ABYSS_PARTICLE_COLOR
static float	ABYSS_SENSOR_RANGE_MULT
static float	ABYSS_VISIBLITY_MULT
protected SectorEntityToken	abyssDarkSource
protected HyperspaceAbyssPlugin	abyssPlugin
protected HyperspaceTerrainPlugin.CellStateTracker[][]	activeCells
protected HyperspaceAutomaton	auto
static final CampaignEngineLayers	BASE
static final CampaignEngineLayers	BASE_OVER
protected boolean	clearedCellsPostLoad
protected float	extraDistanceAroundPlayerToAdvanceStormCells
static final CampaignEngineLayers	FLASH
static final CampaignEngineLayers	FLASH_OVER
protected SpriteAPI	flickerTexture
static final CampaignEngineLayers	GLOW
protected List<HyperspaceTerrainPlugin.CellStateTracker>	savedActiveCells
static final CampaignEngineLayers	SHIVER
static float	STORM_DAMAGE_FRACTION
static float	STORM_MAX_STRIKE_DAMAGE
static float	STORM_MAX_TIMEOUT
static float	STORM_MIN_STRIKE_DAMAGE
static float	STORM_MIN_TIMEOUT
static float	STORM_SENSOR_RANGE_MULT
static float	STORM_SPEED_MULT
static float	STORM_STRIKE_SOUND_RANGE
static String	STORM_STRIKE_TIMEOUT_KEY
static float	STORM_VISIBILITY_FLAT
protected float	stormCellTimeMultOutsideBaseArea
protected String	stormSoundId
protected float[]	temp
static float	TILE_SIZE
static float	VISIBLITY_MULT

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

elapsed, mapTexture, params, sampleCache, samplesForCache, savedTiles, texture, tiles, tileSeed

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

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
protected void	applyStormStrikes(HyperspaceTerrainPlugin.CellStateTracker cell, CampaignFleetAPI fleet, float days)
protected static void	clearCellsNotNearPlayer(HyperspaceTerrainPlugin plugin)
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f test, float r)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
float	getAbyssalDepth(SectorEntityToken other)
float	getAbyssalDepth(SectorEntityToken other, boolean uncapped)
float	getAbyssalDepth(org.lwjgl.util.vector.Vector2f loc)
float	getAbyssalDepth(org.lwjgl.util.vector.Vector2f loc, boolean uncapped)
List<StarSystemAPI>	getAbyssalSystems()
HyperspaceAbyssPlugin	getAbyssPlugin()
HyperspaceTerrainPlugin.CellStateTracker[][]	getActiveCells()
EnumSet<CampaignEngineLayers>	getActiveLayers()	Set of layers can not change.
protected float	getAdjustedSpeedMult(CampaignFleetAPI fleet, float baseMult)
HyperspaceTerrainPlugin.CellStateTracker	getCellAt(SectorEntityToken entity, float extraRadius)
HyperspaceTerrainPlugin.CellStateTracker	getCellAt(org.lwjgl.util.vector.Vector2f location, float radius)
String	getEffectCategory()
HyperspaceTerrainPlugin.CellStateTracker	getExactCellAt(org.lwjgl.util.vector.Vector2f location)
float	getExtraDistanceAroundPlayerToAdvanceStormCells()
String	getNameForTooltip()
String	getNebulaMapTex()
String	getNebulaTex()
int	getNumMapSamples()
float	getProximitySoundFactor()
Color	getRenderColor()
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
HyperspaceTerrainPlugin.LocationState	getStateAt(SectorEntityToken entity, float extraRadius)
float	getStormCellTimeMultOutsideBaseArea()
String	getStormSoundId()
String	getTerrainName()
protected float[]	getThetaAndRadius(Random rand, float width, float height)
int[]	getTile(org.lwjgl.util.vector.Vector2f test)
float	getTileContainsSize()
int[]	getTilePreferStorm(org.lwjgl.util.vector.Vector2f test, float r)
float	getTileRenderSize()
float	getTileSize()
float	getTooltipWidth()
boolean	hasAIFlag(Object flag)
boolean	hasAIFlag(Object flag, CampaignFleetAPI fleet)
boolean	hasTooltip()
void	init(String terrainId, SectorEntityToken entity, Object param)
boolean	isInAbyss(SectorEntityToken other)
boolean	isInClouds(SectorEntityToken other)
boolean	isInClouds(org.lwjgl.util.vector.Vector2f test, float r)
boolean	isTooltipExpandable()
boolean	isUseSampleCache()
static void	main(String[] args)
protected void	playStormStrikeSoundsIfNeeded()
void	preMapRender(float alphaMult)
void	preRender(CampaignEngineLayers layer, float alphaMult)
protected Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult)	First pass.
void	renderOnRadar(org.lwjgl.util.vector.Vector2f radarCenter, float factor, float alphaMult)
protected void	renderQuad(int i, int j, float x, float y, float width, float height, float texX, float texY, float texW, float texH, float angle)
protected void	renderSubArea(float startColumn, float endColumn, float startRow, float endRow, float factor, int samples, float alphaMult)
void	setAbyssPlugin(HyperspaceAbyssPlugin abyssChecker)
void	setExtraDistanceAroundPlayerToAdvanceStormCells(float extraDistanceAroundPlayerToAdvanceStormCells)
void	setStormCellTimeMultOutsideBaseArea(float stormCellTimeMultOutsideBaseArea)
void	setTileState(org.lwjgl.util.vector.Vector2f loc, float radius, HyperspaceTerrainPlugin.CellState state, float waitDur, float signalDur)
void	setTileState(org.lwjgl.util.vector.Vector2f loc, float radius, HyperspaceTerrainPlugin.CellState state, float waitDur, float minSignalDur, float maxSignalDur)
protected boolean	shouldPlayLoopFour()
protected boolean	shouldPlayLoopOne()
protected boolean	shouldPlayLoopThree()
protected boolean	shouldPlayLoopTwo()
void	turnOffStorms(org.lwjgl.util.vector.Vector2f loc, float radius)

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

decodeTiles, encodeTiles, forceClearSampleCache, getExtraSoundRadius, getMaxEffectRadius, getMinEffectRadius, getOptimalEffectRadius, getParams, getTileCenter, getTiles, isTileVisible, regenTiles, renderOnMapAbove, toByteArray, toHexString, updateSampleCache

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

canPlayerHoldStationIn, createCombatSection, createFirstSection, createTravelSection, getEntity, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameAOrAn, getNameColor, getRelatedEntity, getSpec, getTerrainId, hasMapIcon, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, stacksWithSelf

Methods inherited from class java.lang.Object

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

Field Details

ABYSS_MUSIC_SUPPRESSION

public static float ABYSS_MUSIC_SUPPRESSION

ABYSS_VISIBLITY_MULT

public static float ABYSS_VISIBLITY_MULT

ABYSS_SENSOR_RANGE_MULT

public static float ABYSS_SENSOR_RANGE_MULT

ABYSS_BURN_MULT

public static float ABYSS_BURN_MULT

ABYSS_NAVIGATION_EFFECT

public static float ABYSS_NAVIGATION_EFFECT

ABYSS_BACKGROUND_COLOR

public static Color ABYSS_BACKGROUND_COLOR

ABYSS_PARTICLE_COLOR

public static Color ABYSS_PARTICLE_COLOR

ABYSS_LIGHT_COLOR

public static Color ABYSS_LIGHT_COLOR

STORM_STRIKE_TIMEOUT_KEY

public static String STORM_STRIKE_TIMEOUT_KEY

VISIBLITY_MULT

public static float VISIBLITY_MULT

STORM_STRIKE_SOUND_RANGE

public static float STORM_STRIKE_SOUND_RANGE

STORM_MIN_TIMEOUT

public static float STORM_MIN_TIMEOUT

STORM_MAX_TIMEOUT

public static float STORM_MAX_TIMEOUT

STORM_DAMAGE_FRACTION

public static float STORM_DAMAGE_FRACTION

STORM_MIN_STRIKE_DAMAGE

public static float STORM_MIN_STRIKE_DAMAGE

STORM_MAX_STRIKE_DAMAGE

public static float STORM_MAX_STRIKE_DAMAGE

STORM_SPEED_MULT

public static float STORM_SPEED_MULT

STORM_SENSOR_RANGE_MULT

public static float STORM_SENSOR_RANGE_MULT

STORM_VISIBILITY_FLAT

public static float STORM_VISIBILITY_FLAT

TILE_SIZE

public static float TILE_SIZE

FLASH

public static final CampaignEngineLayers FLASH

FLASH_OVER

public static final CampaignEngineLayers FLASH_OVER

GLOW

public static final CampaignEngineLayers GLOW

BASE

public static final CampaignEngineLayers BASE

SHIVER

public static final CampaignEngineLayers SHIVER

BASE_OVER

public static final CampaignEngineLayers BASE_OVER

flickerTexture

protected transient SpriteAPI flickerTexture

activeCells

protected transient HyperspaceTerrainPlugin.CellStateTracker[][] activeCells

savedActiveCells

protected List<HyperspaceTerrainPlugin.CellStateTracker> savedActiveCells

auto

protected HyperspaceAutomaton auto

stormSoundId

protected transient String stormSoundId

abyssPlugin

protected HyperspaceAbyssPlugin abyssPlugin

abyssDarkSource

protected SectorEntityToken abyssDarkSource

temp

protected transient float[] temp

clearedCellsPostLoad

protected transient boolean clearedCellsPostLoad

stormCellTimeMultOutsideBaseArea

protected transient float stormCellTimeMultOutsideBaseArea

extraDistanceAroundPlayerToAdvanceStormCells

protected transient float extraDistanceAroundPlayerToAdvanceStormCells

Constructor Details

HyperspaceTerrainPlugin

public HyperspaceTerrainPlugin()

Method Details

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTiledTerrain

getAbyssPlugin

public HyperspaceAbyssPlugin getAbyssPlugin()

setAbyssPlugin

public void setAbyssPlugin(HyperspaceAbyssPlugin abyssChecker)

readResolve

protected Object readResolve()

getActiveCells

public HyperspaceTerrainPlugin.CellStateTracker[][] getActiveCells()

clearCellsNotNearPlayer

protected static void clearCellsNotNearPlayer(HyperspaceTerrainPlugin plugin)

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 BaseTerrain

Returns:

getThetaAndRadius

protected float[] getThetaAndRadius(Random rand,
 float width,
 float height)

renderQuad

protected void renderQuad(int i,
 int j,
 float x,
 float y,
 float width,
 float height,
 float texX,
 float texY,
 float texW,
 float texH,
 float angle)

Overrides:

renderQuad in class BaseTiledTerrain

getNebulaMapTex

public String getNebulaMapTex()

getNebulaTex

public String getNebulaTex()

getStormCellTimeMultOutsideBaseArea

public float getStormCellTimeMultOutsideBaseArea()

setStormCellTimeMultOutsideBaseArea

public void setStormCellTimeMultOutsideBaseArea(float stormCellTimeMultOutsideBaseArea)

getExtraDistanceAroundPlayerToAdvanceStormCells

public float getExtraDistanceAroundPlayerToAdvanceStormCells()

setExtraDistanceAroundPlayerToAdvanceStormCells

public void setExtraDistanceAroundPlayerToAdvanceStormCells(float extraDistanceAroundPlayerToAdvanceStormCells)

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTiledTerrain

playStormStrikeSoundsIfNeeded

protected void playStormStrikeSoundsIfNeeded()

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTiledTerrain

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 BaseTiledTerrain

Parameters:

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

getTileRenderSize

public float getTileRenderSize()

Specified by:

getTileRenderSize in class BaseTiledTerrain

getTileContainsSize

public float getTileContainsSize()

Specified by:

getTileContainsSize in class BaseTiledTerrain

getTileSize

public float getTileSize()

Specified by:

getTileSize in class BaseTiledTerrain

renderSubArea

protected void renderSubArea(float startColumn,
 float endColumn,
 float startRow,
 float endRow,
 float factor,
 int samples,
 float alphaMult)

Overrides:

renderSubArea in class BaseTiledTerrain

preRender

public void preRender(CampaignEngineLayers layer,
 float alphaMult)

Specified by:

preRender in class BaseTiledTerrain

preMapRender

public void preMapRender(float alphaMult)

Specified by:

preMapRender in class BaseTiledTerrain

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

getRenderColor

public Color getRenderColor()

Specified by:

getRenderColor in class BaseTiledTerrain

containsEntity

public boolean containsEntity(SectorEntityToken other)

Specified by:

containsEntity in interface CampaignTerrainPlugin

Overrides:

containsEntity in class BaseTiledTerrain

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 BaseTiledTerrain

Returns:

containsPoint

public boolean containsPoint(org.lwjgl.util.vector.Vector2f test,
 float r)

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseTiledTerrain

getAbyssalDepth

public float getAbyssalDepth(org.lwjgl.util.vector.Vector2f loc)

getAbyssalDepth

public float getAbyssalDepth(org.lwjgl.util.vector.Vector2f loc,
 boolean uncapped)

getAbyssalDepth

public float getAbyssalDepth(SectorEntityToken other)

getAbyssalDepth

public float getAbyssalDepth(SectorEntityToken other,
 boolean uncapped)

isInAbyss

public boolean isInAbyss(SectorEntityToken other)

getAbyssalSystems

public List<StarSystemAPI> getAbyssalSystems()

isInClouds

public boolean isInClouds(SectorEntityToken other)

isInClouds

public boolean isInClouds(org.lwjgl.util.vector.Vector2f test,
 float r)

getTilePreferStorm

public int[] getTilePreferStorm(org.lwjgl.util.vector.Vector2f test,
 float r)

getExactCellAt

public HyperspaceTerrainPlugin.CellStateTracker getExactCellAt(org.lwjgl.util.vector.Vector2f location)

getTile

public int[] getTile(org.lwjgl.util.vector.Vector2f test)

getStateAt

public HyperspaceTerrainPlugin.LocationState getStateAt(SectorEntityToken entity,
 float extraRadius)

getCellAt

public HyperspaceTerrainPlugin.CellStateTracker getCellAt(org.lwjgl.util.vector.Vector2f location,
 float radius)

getCellAt

public HyperspaceTerrainPlugin.CellStateTracker getCellAt(SectorEntityToken entity,
 float extraRadius)

shouldPlayLoopOne

protected boolean shouldPlayLoopOne()

Overrides:

shouldPlayLoopOne in class BaseTerrain

shouldPlayLoopTwo

protected boolean shouldPlayLoopTwo()

Overrides:

shouldPlayLoopTwo in class BaseTerrain

shouldPlayLoopThree

protected boolean shouldPlayLoopThree()

Overrides:

shouldPlayLoopThree in class BaseTerrain

getProximitySoundFactor

public float getProximitySoundFactor()

Overrides:

getProximitySoundFactor in class BaseTiledTerrain

shouldPlayLoopFour

protected boolean shouldPlayLoopFour()

Overrides:

shouldPlayLoopFour in class BaseTerrain

applyEffect

public void applyEffect(SectorEntityToken entity,
 float days)

Overrides:

applyEffect in class BaseTerrain

applyStormStrikes

protected void applyStormStrikes(HyperspaceTerrainPlugin.CellStateTracker cell,
 CampaignFleetAPI fleet,
 float days)

getStormSoundId

public String getStormSoundId()

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

getNameForTooltip

public String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
 boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

Overrides:

createTooltip in class BaseTerrain

getAdjustedSpeedMult

protected float getAdjustedSpeedMult(CampaignFleetAPI fleet,
 float baseMult)

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

hasAIFlag

public boolean hasAIFlag(Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(Object flag,
 CampaignFleetAPI fleet)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

getNumMapSamples

public int getNumMapSamples()

Overrides:

getNumMapSamples in class BaseTiledTerrain

isUseSampleCache

public boolean isUseSampleCache()

Overrides:

isUseSampleCache in class BaseTiledTerrain

main

public static void main(String[] args)

turnOffStorms

public void turnOffStorms(org.lwjgl.util.vector.Vector2f loc,
 float radius)

setTileState

public void setTileState(org.lwjgl.util.vector.Vector2f loc,
 float radius,
 HyperspaceTerrainPlugin.CellState state,
 float waitDur,
 float signalDur)

setTileState

public void setTileState(org.lwjgl.util.vector.Vector2f loc,
 float radius,
 HyperspaceTerrainPlugin.CellState state,
 float waitDur,
 float minSignalDur,
 float maxSignalDur)