AbilityPlugin.java

Go to the documentation of this file.

 
package com.fs.starfarer.api.characters;
 
import java.awt.Color;
import java.util.EnumSet;
 
import com.fs.starfarer.api.campaign.BattleAPI;
import com.fs.starfarer.api.campaign.CampaignEngineLayers;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.combat.ViewportAPI;
import com.fs.starfarer.api.loading.AbilitySpecAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
 
 
public interface AbilityPlugin {
    void init(String id, SectorEntityToken entity);
    
    void pressButton();
    
    
    void activate();
    
    void deactivate();
    
    
    void cleanup();
    
    
    boolean showActiveIndicator();
    boolean showProgressIndicator();
    boolean showCooldownIndicator();
    
    boolean isUsable();
    
    boolean isActive();
    
    
    boolean isInProgress();
    boolean isOnCooldown();
    
    boolean isActiveOrInProgress();
    
    float getCooldownFraction();
    
    float getProgressFraction();
    
    Color getProgressColor();
    Color getActiveColor();
    Color getCooldownColor();
    
    boolean isCooldownRenderingAdditive();
    
    boolean hasCustomButtonPressSounds();
    
    String getSpriteName();
    SectorEntityToken getEntity();
    String getId();
    
    
    void createTooltip(TooltipMakerAPI tooltip, boolean expanded);
    boolean hasTooltip();
    boolean isTooltipExpandable();
    float getTooltipWidth();
 
    
    
    void forceDisable();
    
    
    void fleetJoinedBattle(BattleAPI battle);
    void fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities);
    
    void fleetOpenedMarket(MarketAPI market);
 
    AbilitySpecAPI getSpec();
    
    
    void render(CampaignEngineLayers layer, ViewportAPI viewport);
    EnumSet<CampaignEngineLayers> getActiveLayers();
 
    void setCooldownLeft(float days);
 
    float getCooldownLeft();
 
    float getLevel();
    
    
}