CampaignTerrainPlugin.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.EnumSet;
 
import java.awt.Color;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.combat.ViewportAPI;
import com.fs.starfarer.api.loading.TerrainSpecAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
 
public interface CampaignTerrainPlugin {
    void init(String terrainId, SectorEntityToken entity, Object param);
    
    String getTerrainId();
    void setTerrainId(String id);
    
    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();
    //String getTerrainNameLowerCase();
    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);
}