com.fs.starfarer.api.campaign.CampaignTerrainPlugin Interface Reference

Public Member Functions
void	init (String terrainId, SectorEntityToken entity, Object param)
String	getTerrainId ()
float	getRenderRange ()
EnumSet< CampaignEngineLayers >	getActiveLayers ()
void	render (CampaignEngineLayers layer, ViewportAPI viewport)
void	advance (float amount)
void	renderOnMap (float factor, float alphaMult)
void	renderOnMapAbove (float factor, float alphaMult)
boolean	containsEntity (SectorEntityToken other)
boolean	containsPoint (Vector2f point, float radius)
boolean	hasMapIcon ()
boolean	hasTooltip ()
void	createTooltip (TooltipMakerAPI tooltip, boolean expanded)
boolean	isTooltipExpandable ()
float	getTooltipWidth ()
String	getTerrainName ()
Color	getNameColor ()
boolean	canPlayerHoldStationIn ()
TerrainSpecAPI	getSpec ()
boolean	hasAIFlag (Object flag)
boolean	hasAIFlag (Object flag, CampaignFleetAPI fleet)
float	getMaxEffectRadius (Vector2f locFrom)
float	getMinEffectRadius (Vector2f locFrom)
float	getOptimalEffectRadius (Vector2f locFrom)
void	setTerrainName (String name)
String	getIconSpriteName ()
void	renderOnRadar (Vector2f radarCenter, float factor, float alphaMult)
String	getNameAOrAn ()
String	getNameForTooltip ()

Detailed Description

Definition at line 12 of file CampaignTerrainPlugin.java.

Member Function Documentation

advance()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.advance

(

float

amount

)

canPlayerHoldStationIn()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.canPlayerHoldStationIn

(

)

containsEntity()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.containsEntity

(

SectorEntityToken

other

)

containsPoint()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.containsPoint	(	Vector2f	point,
		float	radius
	)

createTooltip()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.createTooltip	(	TooltipMakerAPI	tooltip,
		boolean	expanded
	)

getActiveLayers()

EnumSet< CampaignEngineLayers > com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getActiveLayers

(

)

Set of layers can not change.

Returns

getIconSpriteName()

String com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getIconSpriteName

(

)

getMaxEffectRadius()

float com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getMaxEffectRadius

(

Vector2f

locFrom

)

Mainly intended for AI use.

Parameters

locFrom

Returns

getMinEffectRadius()

float com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getMinEffectRadius

(

Vector2f

locFrom

)

Mainly intended for AI use.

Parameters

locFrom

Returns

getNameAOrAn()

String com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getNameAOrAn

(

)

getNameColor()

Color com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getNameColor

(

)

getNameForTooltip()

String com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getNameForTooltip

(

)

getOptimalEffectRadius()

float com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getOptimalEffectRadius

(

Vector2f

locFrom

)

Mainly intended for AI use.

Parameters

locFrom

Returns

getRenderRange()

float com.fs.starfarer.api.campaign.CampaignTerrainPlugin.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

getSpec()

TerrainSpecAPI com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getSpec

(

)

getTerrainId()

String com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getTerrainId

(

)

getTerrainName()

String com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getTerrainName

(

)

getTooltipWidth()

float com.fs.starfarer.api.campaign.CampaignTerrainPlugin.getTooltipWidth

(

)

hasAIFlag() [1/2]

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.hasAIFlag

(

Object

flag

)

hasAIFlag() [2/2]

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.hasAIFlag	(	Object	flag,
		CampaignFleetAPI	fleet
	)

hasMapIcon()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.hasMapIcon

(

)

hasTooltip()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.hasTooltip

(

)

init()

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

isTooltipExpandable()

boolean com.fs.starfarer.api.campaign.CampaignTerrainPlugin.isTooltipExpandable

(

)

render()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.render	(	CampaignEngineLayers	layer,
		ViewportAPI	viewport
	)

renderOnMap()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.renderOnMap	(	float	factor,
		float	alphaMult
	)

First pass.

Parameters

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

renderOnMapAbove()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.renderOnMapAbove	(	float	factor,
		float	alphaMult
	)

Second pass.

Parameters

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

renderOnRadar()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.renderOnRadar	(	Vector2f	radarCenter,
		float	factor,
		float	alphaMult
	)

setTerrainName()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.setTerrainName

(

String

name

)

---

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

• src/com/fs/starfarer/api/campaign/CampaignTerrainPlugin.java