HullModEffect.java

Go to the documentation of this file.

package com.fs.starfarer.api.combat;
 
import java.awt.Color;
 
import com.fs.starfarer.api.campaign.CampaignUIAPI.CoreUITradeMode;
import com.fs.starfarer.api.campaign.CargoStackAPI;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.combat.ShipAPI.HullSize;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.loading.HullModSpecAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
 
public interface HullModEffect {
    void init(HullModSpecAPI spec);
    void applyEffectsBeforeShipCreation(HullSize hullSize, MutableShipStatsAPI stats, String id);
    
    void applyEffectsAfterShipCreation(ShipAPI ship, String id);
    String getDescriptionParam(int index, HullSize hullSize);
    String getDescriptionParam(int index, HullSize hullSize, ShipAPI ship);
 
    void applyEffectsToFighterSpawnedByShip(ShipAPI fighter, ShipAPI ship, String id);
    
    boolean isApplicableToShip(ShipAPI ship);
    
    String getUnapplicableReason(ShipAPI ship);
    
    boolean canBeAddedOrRemovedNow(ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode);
    String getCanNotBeInstalledNowReason(ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode);
    
    
    void advanceInCampaign(FleetMemberAPI member, float amount);
    
    void advanceInCombat(ShipAPI ship, float amount);
    
    boolean affectsOPCosts();
    
    
    boolean shouldAddDescriptionToTooltip(HullSize hullSize, ShipAPI ship, boolean isForModSpec);
    
    void addPostDescriptionSection(TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec);
    
 
    Color getBorderColor();
    Color getNameColor();
    
    int getDisplaySortOrder();
    int getDisplayCategoryIndex();
    
    boolean hasSModEffectSection(HullSize hullSize, ShipAPI ship, boolean isForModSpec);
    void addSModSection(TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList);
    void addSModEffectSection(TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width,
            boolean isForModSpec, boolean isForBuildInList);
    boolean hasSModEffect();
    
    
    void addRequiredItemSection(TooltipMakerAPI tooltip, 
            FleetMemberAPI member, ShipVariantAPI currentVariant, MarketAPI dockedAt,
            float width, boolean isForModSpec);
    
    String getSModDescriptionParam(int index, HullSize hullSize);
    String getSModDescriptionParam(int index, HullSize hullSize, ShipAPI ship);
    
    float getTooltipWidth();
    boolean isSModEffectAPenalty();
    
    boolean showInRefitScreenModPickerFor(ShipAPI ship);
 
    
    default CargoStackAPI getRequiredItem() {
        return null;
    }
    
    default void applyEffectsAfterShipAddedToCombatEngine(ShipAPI ship, String id) {
    }
}