CargoStackAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import com.fs.starfarer.api.campaign.econ.CommoditySpecAPI;
import com.fs.starfarer.api.loading.FighterWingSpecAPI;
import com.fs.starfarer.api.loading.HullModSpecAPI;
import com.fs.starfarer.api.loading.WeaponSpecAPI;
 
 
public interface CargoStackAPI {
    
    public boolean isWeaponStack();
    @Deprecated public boolean isResourceStack();
    boolean isCommodityStack();
    boolean isMarineStack();
    boolean isFuelStack();
    boolean isSupplyStack();
    boolean isCrewStack();
    boolean isPersonnelStack();
    
    String getCommodityId();
    
    public float getCargoSpace();
    public float getCargoSpacePerUnit();
 
    
    public float getSize();
    public float getFree();
    public void setSize(float size);
    public void add(float quantity);
    public void subtract(float quantity);
    
    public float getMaxSize();
    public boolean isFull();
 
    public CargoAPI.CargoItemType getType();
    public void setType(CargoAPI.CargoItemType type);
    
    public boolean isNull();
    
    
    public Object getData();
 
    // these concepts might not survive an actual economy implementation
//  public int getBaseValue();
//  public int getBaseValuePerUnit();
    
    public String getDisplayName();
    
    public CargoAPI getCargo();
    
    int getBaseValuePerUnit();
    WeaponSpecAPI getWeaponSpecIfWeapon();
    
    @Deprecated boolean isModSpecStack();
    boolean isFighterWingStack();
    FighterWingSpecAPI getFighterWingSpecIfWing();
    HullModSpecAPI getHullModSpecIfHullMod();
    CommoditySpecAPI getResourceIfResource();
    
    boolean isSpecialStack();
    SpecialItemData getSpecialDataIfSpecial();
    SpecialItemSpecAPI getSpecialItemSpecIfSpecial();
    
    SpecialItemPlugin getPlugin();
    void setCargo(CargoAPI cargo);
    boolean isInPlayerCargo();
    boolean isPickedUp();
    void setPickedUp(boolean isPickedUp);
 
 
}