com.fs.starfarer.api.campaign

Interface CampaignTerrainPlugin

All Known Implementing Classes:

AsteroidBeltTerrainPlugin, AsteroidFieldTerrainPlugin, BaseRingTerrain, BaseTerrain, BaseTiledTerrain, DebrisFieldTerrainPlugin, EventHorizonPlugin, HyperspaceTerrainPlugin, MagneticFieldTerrainPlugin, NebulaTerrainPlugin, PulsarBeamTerrainPlugin, RadioChatterTerrainPlugin, RingSystemTerrainPlugin, SlipstreamTerrainPlugin, SlipstreamTerrainPlugin2, SpatialAnomalyTerrainPlugin, StarCoronaAkaMainyuTerrainPlugin, StarCoronaJetTerrainPlugin, StarCoronaTerrainPlugin, WavefrontTerrainPlugin

public interface CampaignTerrainPlugin

Method Summary

Methods

Modifier and Type	Method and Description
void	advance(float amount)
boolean	canPlayerHoldStationIn()
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
java.lang.String	getIconSpriteName()
float	getMaxEffectRadius(Vector2f locFrom) Mainly intended for AI use.
float	getMinEffectRadius(Vector2f locFrom) Mainly intended for AI use.
java.lang.String	getNameAOrAn()
java.awt.Color	getNameColor()
java.lang.String	getNameForTooltip()
float	getOptimalEffectRadius(Vector2f locFrom) Mainly intended for AI use.
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
TerrainSpecAPI	getSpec()
java.lang.String	getTerrainId()
java.lang.String	getTerrainName()
float	getTooltipWidth()
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasAIFlag(java.lang.Object flag, CampaignFleetAPI fleet)
boolean	hasMapIcon()
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isTooltipExpandable()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult) First pass.
void	renderOnMapAbove(float factor, float alphaMult) Second pass.
void	renderOnRadar(Vector2f radarCenter, float factor, float alphaMult)
void	setTerrainName(java.lang.String name)

Method Detail

init

void init(java.lang.String terrainId,
        SectorEntityToken entity,
        java.lang.Object param)

getTerrainId

java.lang.String getTerrainId()

getRenderRange

float 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:

getActiveLayers

java.util.EnumSet<CampaignEngineLayers> getActiveLayers()

Set of layers can not change.

Returns:

render

void render(CampaignEngineLayers layer,
          ViewportAPI viewport)

advance

void advance(float amount)

renderOnMap

void 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 renderOnMapAbove(float factor,
                    float alphaMult)

Second pass.

Parameters:

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

alphaMult -

containsEntity

boolean containsEntity(SectorEntityToken other)

containsPoint

boolean containsPoint(Vector2f point,
                    float radius)

hasMapIcon

boolean hasMapIcon()

hasTooltip

boolean hasTooltip()

createTooltip

void createTooltip(TooltipMakerAPI tooltip,
                 boolean expanded)

isTooltipExpandable

boolean isTooltipExpandable()

getTooltipWidth

float getTooltipWidth()

getTerrainName

java.lang.String getTerrainName()

getNameColor

java.awt.Color getNameColor()

canPlayerHoldStationIn

boolean canPlayerHoldStationIn()

getSpec

TerrainSpecAPI getSpec()

hasAIFlag

boolean hasAIFlag(java.lang.Object flag)

hasAIFlag

boolean hasAIFlag(java.lang.Object flag,
                CampaignFleetAPI fleet)

getMaxEffectRadius

float getMaxEffectRadius(Vector2f locFrom)

Mainly intended for AI use.

Parameters:

locFrom -

Returns:

getMinEffectRadius

float getMinEffectRadius(Vector2f locFrom)

Mainly intended for AI use.

Parameters:

locFrom -

Returns:

getOptimalEffectRadius

float getOptimalEffectRadius(Vector2f locFrom)

Mainly intended for AI use.

Parameters:

locFrom -

Returns:

setTerrainName

void setTerrainName(java.lang.String name)

getIconSpriteName

java.lang.String getIconSpriteName()

renderOnRadar

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

getNameAOrAn

java.lang.String getNameAOrAn()

getNameForTooltip

java.lang.String getNameForTooltip()