CampaignEventPlugin.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign.events;
 
import java.awt.Color;
import java.util.List;
import java.util.Map;
 
import com.fs.starfarer.api.campaign.InteractionDialogAPI;
import com.fs.starfarer.api.campaign.comm.MessagePriority;
import com.fs.starfarer.api.campaign.econ.CommodityOnMarketAPI;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.campaign.rules.MemoryAPI;
import com.fs.starfarer.api.impl.campaign.rulecmd.CallEvent.CallableEvent;
import com.fs.starfarer.api.util.Misc.Token;
 
 
public interface CampaignEventPlugin extends CallableEvent {
 
    //public static final String SUBJECT = "cep_subject";
    
    public static enum CampaignEventCategory {
        EVENT,
        BOUNTY,
        MISSION,
        DO_NOT_SHOW_IN_MESSAGE_FILTER,
    }
    
    public static interface PriceUpdatePlugin {
        public static enum PriceType {
            CHEAP,
            EXPENSIVE,
            NORMAL,
        }
        
        MarketAPI getMarket();
        CommodityOnMarketAPI getCommodity();
        float getSupplyPrice();
        float getDemandPrice();
        PriceType getType();
        long getTimestamp();
        void updateType();
        float getDemand();
        float getAvailable();
        int getRoundedPriceForDisplay();
    }
    
    
    
    String getId();
    
    void init(String eventType, CampaignEventTarget eventTarget);
    
    
    void cleanup();
    
    
    void setProbability(float p);
    
    void startEvent();
    
    void advance(float amount);
    boolean isDone();
    
    CampaignEventTarget getEventTarget();
    String getEventType();
    
    
    Map<String, String> getTokenReplacements();
    
    String[] getHighlights(String stageId);
    
    Color[] getHighlightColors(String stageId);
    
    
    String getStageIdForPossible();
    
    
    MessagePriority getWarningWhenPossiblePriority();
    
    
    String getStageIdForLikely();
    
    MessagePriority getWarningWhenLikelyPriority();
    
    
    void setParam(Object param);
    
    @Deprecated boolean allowMultipleOngoingForSameTarget();
    
    String getEventName();
    boolean useEventNameAsId();
    
    CampaignEventCategory getEventCategory();
    
    List<String> getRelatedCommodities();
    List<PriceUpdatePlugin> getPriceUpdates();
    
    String getCurrentMessageIcon();
 
 
    String getCurrentImage();
 
 
    String getEventIcon();
    
    
    boolean showAllMessagesIfOngoing();
    
    
    boolean callEvent(String ruleId, InteractionDialogAPI dialog, List<Token> params, Map<String, MemoryAPI> memoryMap);
    
    MemoryAPI getMemory();
 
    boolean showLatestMessageIfOngoing();
}