Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.campaign.CampaignTerrainPlugin Interface Reference
Inheritance diagram for com.fs.starfarer.api.campaign.CampaignTerrainPlugin:
[legend]

Public Member Functions

void init (String terrainId, SectorEntityToken entity, Object param)
 
String getTerrainId ()
 
void setTerrainId (String id)
 
float getRenderRange ()
 
EnumSet< CampaignEngineLayersgetActiveLayers ()
 
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 ()
 
void setEntity (SectorEntityToken entity)
 

Detailed Description

Definition at line 13 of file CampaignTerrainPlugin.java.

Member Function Documentation

◆ advance()

◆ canPlayerHoldStationIn()

◆ containsEntity()

◆ containsPoint()

◆ createTooltip()

◆ getActiveLayers()

◆ getIconSpriteName()

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

◆ getMaxEffectRadius()

◆ getMinEffectRadius()

◆ getNameAOrAn()

◆ getNameColor()

◆ getNameForTooltip()

◆ getOptimalEffectRadius()

◆ getRenderRange()

◆ getSpec()

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

◆ getTerrainId()

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

◆ getTerrainName()

◆ getTooltipWidth()

◆ hasAIFlag() [1/2]

◆ hasAIFlag() [2/2]

◆ hasMapIcon()

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

◆ hasTooltip()

◆ init()

◆ isTooltipExpandable()

◆ render()

◆ renderOnMap()

◆ renderOnMapAbove()

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

Second pass.

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

Implemented in com.fs.starfarer.api.impl.campaign.terrain.BaseRingTerrain, com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain, and com.fs.starfarer.api.impl.campaign.terrain.BaseTiledTerrain.

◆ renderOnRadar()

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

◆ setEntity()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.setEntity ( SectorEntityToken entity)

◆ setTerrainId()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.setTerrainId ( String id)

◆ setTerrainName()

void com.fs.starfarer.api.campaign.CampaignTerrainPlugin.setTerrainName ( String name)

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