Inheritance diagram for com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain:

Collaboration diagram for com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain:

Classes
class	TileParams

class	TileSample

Public Member Functions
void	init (String terrainId, SectorEntityToken entity, Object param)

int[][]	getTiles ()

TileParams	getParams ()

boolean	containsEntity (SectorEntityToken other)

boolean	containsPoint (Vector2f test, float r)

abstract float	getTileSize ()

abstract float	getTileRenderSize ()

abstract float	getTileContainsSize ()

abstract void	preRender (CampaignEngineLayers layer, float alphaMult)

abstract void	preMapRender (float alphaMult)

abstract Color	getRenderColor ()

float	getRenderRange ()

void	render (CampaignEngineLayers layer, ViewportAPI v)

boolean	isTileVisible (int i, int j)

void	renderOnMap (float factor, float alphaMult)

int	getNumMapSamples ()

void	renderOnMapAbove (float factor, float alphaMult)

float[]	getTileCenter (int i, int j)

boolean	isUseSampleCache ()

void	forceClearSampleCache ()

void	updateSampleCache (int samples, boolean force)

void	advance (float amount)

float	getMaxEffectRadius (Vector2f locFrom)

float	getMinEffectRadius (Vector2f locFrom)

float	getOptimalEffectRadius (Vector2f locFrom)

float	getProximitySoundFactor ()

Public Member Functions inherited from com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain
String	getIconSpriteName ()

SectorEntityToken	getRelatedEntity ()

SectorEntityToken	getEntity ()

void	setEntity (SectorEntityToken entity)

String	getTerrainId ()

void	setTerrainId (String id)

String	getEffectCategory ()

boolean	stacksWithSelf ()

void	applyEffect (SectorEntityToken entity, float days)

String	getModId ()

EnumSet< CampaignEngineLayers >	getActiveLayers ()

boolean	hasTooltip ()

void	createTooltip (TooltipMakerAPI tooltip, boolean expanded)

boolean	isTooltipExpandable ()

float	getTooltipWidth ()

String	getTerrainName ()

String	getNameAOrAn ()

void	setTerrainName (String name)

Color	getNameColor ()

boolean	hasAIFlag (Object flag)

boolean	hasAIFlag (Object flag, CampaignFleetAPI fleet)

boolean	hasMapIcon ()

TerrainSpecAPI	getSpec ()

boolean	canPlayerHoldStationIn ()

void	renderOnRadar (Vector2f radarCenter, float factor, float alphaMult)

String	getNameForTooltip ()

boolean	isPreventedFromAffecting (SectorEntityToken other)

Public Member Functions inherited from com.fs.starfarer.api.campaign.CampaignTerrainPlugin

Static Public Member Functions
static String	encodeTiles (int[][] tiles)

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

static String	toHexString (byte[] array)

static byte[]	toByteArray (String s)

static void	main (String[] args) throws DataFormatException

Protected Member Functions
void	regenTiles ()

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

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

float	getExtraSoundRadius ()

Protected Member Functions inherited from com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain
boolean	shouldCheckFleetsToApplyEffect ()

void	createFirstSection (TooltipMakerAPI tooltip, boolean expanded)

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

void	createCombatSection (TooltipMakerAPI tooltip, boolean expanded)

boolean	shouldPlayLoopOne ()

boolean	shouldPlayLoopTwo ()

boolean	shouldPlayLoopThree ()

boolean	shouldPlayLoopFour ()

float	getLoopOnePitch ()

float	getLoopOneVolume ()

float	getLoopTwoPitch ()

float	getLoopTwoVolume ()

float	getLoopThreePitch ()

float	getLoopThreeVolume ()

float	getLoopFourPitch ()

float	getLoopFourVolume ()

void	preventOtherTerrainFromAffecting (SectorEntityToken other)

void	preventOtherTerrainFromAffecting (SectorEntityToken other, float dur)

Protected Attributes
TileParams	params

transient SpriteAPI	texture

transient SpriteAPI	mapTexture

transient int[][]	tiles

long	tileSeed

String	savedTiles

transient TileSample[][]	sampleCache = null

transient int	samplesForCache = 0

float	elapsed = 0f

Protected Attributes inherited from com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain
SectorEntityToken	entity

String	terrainId

String	name = "Unknown"

Additional Inherited Members
Static Public Attributes inherited from com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain
static final float	EXTRA_SOUND_RADIUS = 100f

static String	TERRAIN_LOCK_KEY = "$terrain_mutex_key"

Detailed Description

Definition at line 24 of file BaseTiledTerrain.java.

Member Function Documentation

◆ advance()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.advance ( float amount )

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

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

Definition at line 560 of file BaseTiledTerrain.java.

◆ containsEntity()

boolean com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.containsEntity ( SectorEntityToken other )

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

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

Definition at line 152 of file BaseTiledTerrain.java.

◆ containsPoint()

boolean com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.containsPoint	(	Vector2f	test,
		float	r )

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

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

Definition at line 157 of file BaseTiledTerrain.java.

◆ decodeTiles()

static int[][] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.decodeTiles	(	String	string,
		int	w,
		int	h ) throws DataFormatException

static

Definition at line 809 of file BaseTiledTerrain.java.

◆ encodeTiles()

static String com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.encodeTiles ( int tiles[][] )

static

Definition at line 701 of file BaseTiledTerrain.java.

◆ forceClearSampleCache()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.forceClearSampleCache ( )

Definition at line 356 of file BaseTiledTerrain.java.

◆ getExtraSoundRadius()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getExtraSoundRadius ( )

protected

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

Definition at line 624 of file BaseTiledTerrain.java.

◆ getMaxEffectRadius()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getMaxEffectRadius ( Vector2f locFrom )

Mainly intended for AI use.

Parameters

locFrom

Returns

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

Definition at line 604 of file BaseTiledTerrain.java.

◆ getMinEffectRadius()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getMinEffectRadius ( Vector2f locFrom )

Mainly intended for AI use.

Parameters

locFrom

Returns

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

Definition at line 613 of file BaseTiledTerrain.java.

◆ getNumMapSamples()

int com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getNumMapSamples ( )

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

Definition at line 319 of file BaseTiledTerrain.java.

◆ getOptimalEffectRadius()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getOptimalEffectRadius ( Vector2f locFrom )

Mainly intended for AI use.

Parameters

locFrom

Returns

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

Definition at line 617 of file BaseTiledTerrain.java.

◆ getParams()

TileParams com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getParams ( )

Definition at line 121 of file BaseTiledTerrain.java.

◆ getProximitySoundFactor()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getProximitySoundFactor ( )

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

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

Definition at line 629 of file BaseTiledTerrain.java.

◆ getRenderColor()

abstract Color com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getRenderColor ( )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ getRenderRange()

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getRenderRange ( )

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.

Returns

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

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

Definition at line 219 of file BaseTiledTerrain.java.

◆ getTileCenter()

float[] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getTileCenter	(	int	i,
		int	j )

Definition at line 327 of file BaseTiledTerrain.java.

◆ getTileContainsSize()

abstract float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getTileContainsSize ( )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ getTileRenderSize()

abstract float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getTileRenderSize ( )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ getTiles()

int[][] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getTiles ( )

Definition at line 117 of file BaseTiledTerrain.java.

◆ getTileSize()

abstract float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.getTileSize ( )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ init()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.init	(	String	terrainId,
		SectorEntityToken	entity,
		Object	param )

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

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

Definition at line 64 of file BaseTiledTerrain.java.

◆ isTileVisible()

boolean com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.isTileVisible	(	int	i,
		int	j )

Definition at line 271 of file BaseTiledTerrain.java.

◆ isUseSampleCache()

boolean com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.isUseSampleCache ( )

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

Definition at line 352 of file BaseTiledTerrain.java.

◆ main()

static void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.main ( String[] args ) throws DataFormatException

static

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

Definition at line 857 of file BaseTiledTerrain.java.

◆ preMapRender()

abstract void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.preMapRender ( float alphaMult )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ preRender()

abstract void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.preRender	(	CampaignEngineLayers	layer,
		float	alphaMult )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

◆ regenTiles()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.regenTiles ( )

protected

Definition at line 100 of file BaseTiledTerrain.java.

◆ render()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.render	(	CampaignEngineLayers	layer,
		ViewportAPI	v )

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

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

Definition at line 227 of file BaseTiledTerrain.java.

◆ renderOnMap()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.renderOnMap	(	float	factor,
		float	alphaMult )

First pass.

Parameters

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

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

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

Definition at line 312 of file BaseTiledTerrain.java.

◆ renderOnMapAbove()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.renderOnMapAbove	(	float	factor,
		float	alphaMult )

Second pass.

Parameters

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

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

Definition at line 323 of file BaseTiledTerrain.java.

◆ renderQuad()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.renderQuad	(	int	i,
		int	j,
		float	x,
		float	y,
		float	width,
		float	height,
		float	texX,
		float	texY,
		float	texW,
		float	texH,
		float	angle )

protected

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

Definition at line 567 of file BaseTiledTerrain.java.

◆ renderSubArea()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.renderSubArea	(	float	startColumn,
		float	endColumn,
		float	startRow,
		float	endRow,
		float	factor,
		int	samples,
		float	alphaMult )

protected

Reimplemented in com.fs.starfarer.api.impl.campaign.terrain.HyperspaceTerrainPlugin, and com.fs.starfarer.api.impl.campaign.terrain.NebulaTerrainPlugin.

Definition at line 419 of file BaseTiledTerrain.java.

◆ toByteArray()

static byte[] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.toByteArray ( String s )

static

Definition at line 851 of file BaseTiledTerrain.java.

◆ toHexString()

static String com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.toHexString ( byte[] array )

static

Definition at line 847 of file BaseTiledTerrain.java.

◆ updateSampleCache()

void com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.updateSampleCache	(	int	samples,
		boolean	force )

Definition at line 359 of file BaseTiledTerrain.java.

Member Data Documentation

◆ elapsed

float com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.elapsed = 0f

protected

Definition at line 558 of file BaseTiledTerrain.java.

◆ mapTexture

transient SpriteAPI com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.mapTexture

protected

Definition at line 58 of file BaseTiledTerrain.java.

◆ params

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

protected

Definition at line 56 of file BaseTiledTerrain.java.

◆ sampleCache

transient TileSample [][] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.sampleCache = null

protected

Definition at line 349 of file BaseTiledTerrain.java.

◆ samplesForCache

transient int com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.samplesForCache = 0

protected

Definition at line 350 of file BaseTiledTerrain.java.

◆ savedTiles

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

protected

Definition at line 63 of file BaseTiledTerrain.java.

◆ texture

transient SpriteAPI com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.texture

protected

Definition at line 57 of file BaseTiledTerrain.java.

◆ tiles

transient int [][] com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.tiles

protected

Definition at line 60 of file BaseTiledTerrain.java.

◆ tileSeed

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

protected

Definition at line 62 of file BaseTiledTerrain.java.

The documentation for this class was generated from the following file:

src/com/fs/starfarer/api/impl/campaign/terrain/BaseTiledTerrain.java

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ advance()

◆ containsEntity()

◆ containsPoint()

◆ decodeTiles()

◆ encodeTiles()

◆ forceClearSampleCache()

◆ getExtraSoundRadius()

◆ getMaxEffectRadius()

◆ getMinEffectRadius()

◆ getNumMapSamples()

◆ getOptimalEffectRadius()

◆ getParams()

◆ getProximitySoundFactor()

◆ getRenderColor()

◆ getRenderRange()

◆ getTileCenter()

◆ getTileContainsSize()

◆ getTileRenderSize()

◆ getTiles()

◆ getTileSize()

◆ init()

◆ isTileVisible()

◆ isUseSampleCache()

◆ main()

◆ preMapRender()

◆ preRender()

◆ regenTiles()

◆ render()

◆ renderOnMap()

◆ renderOnMapAbove()

◆ renderQuad()

◆ renderSubArea()

◆ toByteArray()

◆ toHexString()

◆ updateSampleCache()

Member Data Documentation

◆ elapsed

◆ mapTexture

◆ params

◆ sampleCache

◆ samplesForCache

◆ savedTiles

◆ texture

◆ tiles

◆ tileSeed