Package 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 Details

    • init

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

    • getTerrainId

      String getTerrainId()

    • setTerrainId

      void setTerrainId(String id)

    • 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

      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(org.lwjgl.util.vector.Vector2f point, float radius)

    • hasMapIcon

      boolean hasMapIcon()

    • hasTooltip

      boolean hasTooltip()

    • createTooltip

      void createTooltip(TooltipMakerAPI tooltip, boolean expanded)

    • isTooltipExpandable

      boolean isTooltipExpandable()

    • getTooltipWidth

      float getTooltipWidth()

    • getTerrainName

      String getTerrainName()

    • getNameColor

      Color getNameColor()

    • canPlayerHoldStationIn

      boolean canPlayerHoldStationIn()

    • getSpec

      TerrainSpecAPI getSpec()

    • hasAIFlag

      boolean hasAIFlag(Object flag)

    • hasAIFlag

      boolean hasAIFlag(Object flag, CampaignFleetAPI fleet)

    • getMaxEffectRadius

      float getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)
      Mainly intended for AI use.
      Parameters:
      locFrom -
      Returns:

    • getMinEffectRadius

      float getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)
      Mainly intended for AI use.
      Parameters:
      locFrom -
      Returns:

    • getOptimalEffectRadius

      float getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)
      Mainly intended for AI use.
      Parameters:
      locFrom -
      Returns:

    • setTerrainName

      void setTerrainName(String name)

    • getIconSpriteName

      String getIconSpriteName()

    • renderOnRadar

      void renderOnRadar(org.lwjgl.util.vector.Vector2f radarCenter, float factor, float alphaMult)

    • getNameAOrAn

      String getNameAOrAn()

    • getNameForTooltip

      String getNameForTooltip()

    • setEntity

      void setEntity(SectorEntityToken entity)