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

Class NebulaTerrainPlugin

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

All Implemented Interfaces:

CampaignTerrainPlugin, BattleCreationPluginImpl.NebulaTextureProvider

public class NebulaTerrainPlugin
extends BaseTiledTerrain
implements BattleCreationPluginImpl.NebulaTextureProvider

Nested Class Summary

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 final float	TILE_SIZE
static final 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
NebulaTerrainPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
EnumSet<CampaignEngineLayers>	getActiveLayers()	Set of layers can not change.
String	getEffectCategory()
String	getNameForTooltip()
String	getNebulaMapTex()
String	getNebulaTex()
Color	getRenderColor()
float	getTileContainsSize()
float	getTileRenderSize()
float	getTileSize()
float	getTooltipWidth()
boolean	hasAIFlag(Object flag)
boolean	hasTooltip()
void	init(String terrainId, SectorEntityToken entity, Object param)
boolean	isTooltipExpandable()
void	preMapRender(float alphaMult)
void	preRender(CampaignEngineLayers layer, float alphaMult)
protected Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
protected void	renderSubArea(float startColumn, float endColumn, float startRow, float endRow, float factor, int samples, float alphaMult)

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

containsEntity, containsPoint, decodeTiles, encodeTiles, forceClearSampleCache, getExtraSoundRadius, getMaxEffectRadius, getMinEffectRadius, getNumMapSamples, getOptimalEffectRadius, getParams, getProximitySoundFactor, getRenderRange, getTileCenter, getTiles, isTileVisible, isUseSampleCache, main, regenTiles, renderOnMap, renderOnMapAbove, renderQuad, 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, 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 Details

TILE_SIZE

public static final float TILE_SIZE

See Also:

• Constant Field Values

VISIBLITY_MULT

public static final float VISIBLITY_MULT

See Also:

• Constant Field Values

Constructor Details

NebulaTerrainPlugin

public NebulaTerrainPlugin()

Method Details

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTiledTerrain

getNameForTooltip

public String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

readResolve

protected Object readResolve()

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:

getNebulaMapTex

public String getNebulaMapTex()

Specified by:

getNebulaMapTex in interface BattleCreationPluginImpl.NebulaTextureProvider

getNebulaTex

public String getNebulaTex()

Specified by:

getNebulaTex in interface BattleCreationPluginImpl.NebulaTextureProvider

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTiledTerrain

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTiledTerrain

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

getRenderColor

public Color getRenderColor()

Specified by:

getRenderColor in class BaseTiledTerrain

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

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

Overrides:

getEffectCategory in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain