IntelInfoPlugin.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign.comm;
 
import java.util.List;
import java.util.Set;
 
import java.awt.Color;
 
import com.fs.starfarer.api.campaign.FactionAPI;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import com.fs.starfarer.api.campaign.StoryPointActionDelegate;
import com.fs.starfarer.api.ui.CustomPanelAPI;
import com.fs.starfarer.api.ui.IntelUIAPI;
import com.fs.starfarer.api.ui.SectorMapAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
import com.fs.starfarer.api.ui.UIPanelAPI;
 
public interface IntelInfoPlugin {
    
    public static class TableRowClickData {
        public Object rowId;
        public UIPanelAPI table;
        public TableRowClickData(Object rowId, UIPanelAPI table) {
            this.rowId = rowId;
            this.table = table;
        }
        
    }
    
    public static enum ListInfoMode {
        MESSAGES,
        INTEL,
        MAP_TOOLTIP,
        IN_DESC, // not used from core but useful for some implementation details
    }
    
    public static class ArrowData {
        public float alphaMult = 0.33f;
        public float width = 10f;
        public SectorEntityToken from;
        public SectorEntityToken to;
        public Color color;
        
        public ArrowData(SectorEntityToken from, SectorEntityToken to) {
            this.from = from;
            this.to = to;
        }
 
        public ArrowData(float width, SectorEntityToken from, SectorEntityToken to) {
            this.width = width;
            this.from = from;
            this.to = to;
        }
 
        public ArrowData(float width, SectorEntityToken from, SectorEntityToken to, Color color) {
            this.width = width;
            this.from = from;
            this.to = to;
            this.color = color;
        }
    }
    
    public static final float LIST_ITEM_TEXT_WIDTH = 261f;
    public static final float NEW_DAYS = 5f;
    
    public static enum IntelSortTier {
        TIER_0,
        TIER_1,
        TIER_2,
        TIER_3, // default
        TIER_4,
        TIER_5,
        TIER_6,
        TIER_COMPLETED,
    }
    
    
    String getIcon();
    
    String getImportantIcon();
    
    boolean hasImportantButton();
    boolean canTurnImportantOff();
    
    
    Color getBackgroundGlowColor();
    
//  void createIntelListInfo(TooltipMakerAPI info);
//  void createMessageListInfo(TooltipMakerAPI info);
    
    void createIntelInfo(TooltipMakerAPI info, ListInfoMode mode);
 
    boolean hasSmallDescription();
    String getSmallDescriptionTitle();
    void createSmallDescription(TooltipMakerAPI info, float width, float height);
    
    boolean hasLargeDescription();
    void createLargeDescription(CustomPanelAPI panel, float width, float height);
    
    void notifyPlayerAboutToOpenIntelScreen();
    boolean shouldRemoveIntel();
    
    Set<String> getIntelTags(SectorMapAPI map);
    boolean isImportant();
    void setImportant(Boolean important);
    SectorEntityToken getMapLocation(SectorMapAPI map);
    
    List<ArrowData> getArrowData(SectorMapAPI map);
    
    
    boolean doesButtonHaveConfirmDialog(Object buttonId);
    StoryPointActionDelegate getButtonStoryPointActionDelegate(Object buttonId);
    float getConfirmationPromptWidth(Object buttonId);
    void createConfirmationPrompt(Object buttonId, TooltipMakerAPI prompt);
    String getConfirmText(Object buttonId);
    String getCancelText(Object buttonId);
    FactionAPI getFactionForUIColors();
    
    void buttonPressConfirmed(Object buttonId, IntelUIAPI ui);
    void buttonPressCancelled(Object buttonId, IntelUIAPI ui);
    void storyActionConfirmed(Object buttonId, IntelUIAPI ui);
    
    void setPlayerVisibleTimestamp(Long timestamp);
    Long getPlayerVisibleTimestamp();
    boolean autoAddCampaignMessage();
    String getCommMessageSound();
    
    boolean canMakeVisibleToPlayer(boolean playerInRelayRange);
    void reportMadeVisibleToPlayer();
    void reportPlayerClickedOn();
    void reportRemovedIntel();
    
    boolean isNew();
    void setNew(boolean isNew);
    
    IntelSortTier getSortTier();
    String getSortString();
 
    
    boolean isHidden();
    void setHidden(boolean hidden); 
    
    float getTimeRemainingFraction();
 
    
    Color getCircleBorderColorOverride();
    
    boolean forceAddNextFrame();
    void setForceAddNextFrame(boolean add);
 
    boolean isEnded();
 
    boolean isEnding();
 
 
    void tableRowClicked(IntelUIAPI ui, TableRowClickData data);
 
    Set<String> getTagsForSort();
    void setTagsForSort(Set<String> tagsForSort);
}