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

Class BaseTiledTerrain

java.lang.Object

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

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

All Implemented Interfaces:

CampaignTerrainPlugin

Direct Known Subclasses:

HyperspaceTerrainPlugin, NebulaTerrainPlugin

public abstract class BaseTiledTerrain
extends BaseTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseTiledTerrain.TileParams
static class	BaseTiledTerrain.TileSample

Field Summary

Fields

Modifier and Type	Field	Description
protected float	elapsed
protected SpriteAPI	mapTexture
protected BaseTiledTerrain.TileParams	params
protected BaseTiledTerrain.TileSample[][]	sampleCache
protected int	samplesForCache
protected String	savedTiles
protected SpriteAPI	texture
protected int[][]	tiles
protected long	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
BaseTiledTerrain()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f test, float r)
static int[][]	decodeTiles(String string, int w, int h)
static String	encodeTiles(int[][] tiles)
void	forceClearSampleCache()
protected float	getExtraSoundRadius()
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.
int	getNumMapSamples()
float	getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)	Mainly intended for AI use.
BaseTiledTerrain.TileParams	getParams()
float	getProximitySoundFactor()
abstract Color	getRenderColor()
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
float[]	getTileCenter(int i, int j)
abstract float	getTileContainsSize()
abstract float	getTileRenderSize()
int[][]	getTiles()
abstract float	getTileSize()
void	init(String terrainId, SectorEntityToken entity, Object param)
boolean	isTileVisible(int i, int j)
boolean	isUseSampleCache()
static void	main(String[] args)
abstract void	preMapRender(float alphaMult)
abstract void	preRender(CampaignEngineLayers layer, float alphaMult)
protected void	regenTiles()
void	render(CampaignEngineLayers layer, ViewportAPI v)
void	renderOnMap(float factor, float alphaMult)	First pass.
void	renderOnMapAbove(float factor, float alphaMult)	Second pass.
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)
static byte[]	toByteArray(String s)
static String	toHexString(byte[] array)
void	updateSampleCache(int samples, boolean force)

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

applyEffect, canPlayerHoldStationIn, createCombatSection, createFirstSection, createTooltip, createTravelSection, getActiveLayers, getEffectCategory, getEntity, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameAOrAn, getNameColor, getNameForTooltip, getRelatedEntity, getSpec, getTerrainId, getTerrainName, getTooltipWidth, hasAIFlag, hasAIFlag, hasMapIcon, hasTooltip, isPreventedFromAffecting, isTooltipExpandable, 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

params

protected BaseTiledTerrain.TileParams params

texture

protected transient SpriteAPI texture

mapTexture

protected transient SpriteAPI mapTexture

tiles

protected transient int[][] tiles

tileSeed

protected long tileSeed

savedTiles

protected String savedTiles

sampleCache

protected transient BaseTiledTerrain.TileSample[][] sampleCache

samplesForCache

protected transient int samplesForCache

elapsed

protected float elapsed

Constructor Details

BaseTiledTerrain

public BaseTiledTerrain()

Method Details

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTerrain

regenTiles

protected void regenTiles()

getTiles

public int[][] getTiles()

getParams

public BaseTiledTerrain.TileParams getParams()

containsEntity

public boolean containsEntity(SectorEntityToken other)

Specified by:

containsEntity in interface CampaignTerrainPlugin

Overrides:

containsEntity in class BaseTerrain

containsPoint

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

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseTerrain

getTileSize

public abstract float getTileSize()

getTileRenderSize

public abstract float getTileRenderSize()

getTileContainsSize

public abstract float getTileContainsSize()

preRender

public abstract void preRender(CampaignEngineLayers layer,
 float alphaMult)

preMapRender

public abstract void preMapRender(float alphaMult)

getRenderColor

public abstract Color getRenderColor()

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 BaseTerrain

Returns:

render

public void render(CampaignEngineLayers layer,
 ViewportAPI v)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTerrain

isTileVisible

public boolean isTileVisible(int i,
 int j)

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 BaseTerrain

Parameters:

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

getNumMapSamples

public int getNumMapSamples()

renderOnMapAbove

public void renderOnMapAbove(float factor,
 float alphaMult)

Description copied from interface: CampaignTerrainPlugin

Second pass.

Specified by:

renderOnMapAbove in interface CampaignTerrainPlugin

Overrides:

renderOnMapAbove in class BaseTerrain

Parameters:

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

getTileCenter

public float[] getTileCenter(int i,
 int j)

isUseSampleCache

public boolean isUseSampleCache()

forceClearSampleCache

public void forceClearSampleCache()

updateSampleCache

public void updateSampleCache(int samples,
 boolean force)

renderSubArea

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

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

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)

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

Overrides:

getMaxEffectRadius in class BaseTerrain

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

Overrides:

getMinEffectRadius in class BaseTerrain

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

Overrides:

getOptimalEffectRadius in class BaseTerrain

Returns:

getExtraSoundRadius

protected float getExtraSoundRadius()

Overrides:

getExtraSoundRadius in class BaseTerrain

getProximitySoundFactor

public float getProximitySoundFactor()

Overrides:

getProximitySoundFactor in class BaseTerrain

encodeTiles

public static String encodeTiles(int[][] tiles)

decodeTiles

public static int[][] decodeTiles(String string,
 int w,
 int h)
                           throws DataFormatException

Throws:

DataFormatException

toHexString

public static String toHexString(byte[] array)

toByteArray

public static byte[] toByteArray(String s)

main

public static void main(String[] args)
                 throws DataFormatException

Throws:

DataFormatException