SpecialItemPlugin.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.Random;
 
import java.awt.Color;
 
import org.json.JSONException;
 
import com.fs.starfarer.api.campaign.CargoAPI.CargoItemType;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.campaign.econ.SubmarketAPI;
import com.fs.starfarer.api.graphics.SpriteAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
 
public interface SpecialItemPlugin {
    public static interface RightClickActionHelper {
        void removeFromClickedStackFirst(int num);
        void removeFromAnyStack(CargoItemType type, Object data, int num);
        void addItems(CargoItemType type, Object data, float quantity);
        float getNumItems(CargoItemType type, Object data);
    }
    
    public interface SpecialItemRendererAPI {
        void renderSchematic(SpriteAPI sprite, float cx, float cy, float alphaMult);
        void renderScanlines(SpriteAPI sprite, float cx, float cy, float alphaMult);
        void renderScanlinesWithCorners(float blX, float blY, float tlX, float tlY,
                                        float trX, float trY, float brX, float brY,
                                        float alphaMult, boolean additive);
        void renderSchematicWithCorners(SpriteAPI sprite, Color color, 
                                       float blX, float blY, float tlX, float tlY,
                                       float trX, float trY, float brX, float brY,
                                       float alphaMult);
        void renderShipWithCorners(String hullOrWingId, Color bgColor,
                float blX, float blY, float tlX, float tlY, float trX,
                float trY, float brX, float brY, float alphaMult, float glowMult, boolean withSpotlight);
        void renderBGWithCorners(Color bgColor, float blX, float blY,
                float tlX, float tlY, float trX, float trY, float brX,
                float brY, float alphaMult, float glowMult, boolean additive);
        void renderWeaponWithCorners(String weaponId, float blX, float blY,
                float tlX, float tlY, float trX, float trY, float brX,
                float brY, float alphaMult, float glowMult, boolean withSpotlight);
 
    }
    
    void setId(String id);
    void init(CargoStackAPI stack);
    
    String getName();
    int getPrice(MarketAPI market, SubmarketAPI submarket);
    
    boolean hasRightClickAction();
    void performRightClickAction();
    void performRightClickAction(RightClickActionHelper helper);
    
    boolean shouldRemoveOnRightClickAction();
    
//  int getNumToRemove();
//  boolean shouldRemoveCalledAfterRightClickAction();
//  void setReadOnlyCargoForRightClickAction(CargoAPI cargo);
    
    boolean isTooltipExpandable();
    float getTooltipWidth();
    void createTooltip(TooltipMakerAPI tooltip, boolean expanded, CargoTransferHandlerAPI transferHandler, Object stackSource);
    
    void render(float x, float y, float w, float h, float alphaMult, float glowMult, SpecialItemRendererAPI renderer);
    
    String resolveDropParamsToSpecificItemData(String params, Random random) throws JSONException;
    String getDesignType();
    
    SpecialItemSpecAPI getSpec();
}