MarketAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign.econ;
 
import java.awt.Color;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.campaign.CampaignFleetAPI;
import com.fs.starfarer.api.campaign.CommDirectoryAPI;
import com.fs.starfarer.api.campaign.FactionAPI;
import com.fs.starfarer.api.campaign.FactionAPI.ShipPickParams;
import com.fs.starfarer.api.campaign.LocationAPI;
import com.fs.starfarer.api.campaign.PlanetAPI;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import com.fs.starfarer.api.campaign.StarSystemAPI;
import com.fs.starfarer.api.campaign.rules.HasMemory;
import com.fs.starfarer.api.campaign.rules.MemoryAPI;
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.combat.MutableStat;
import com.fs.starfarer.api.combat.MutableStatWithTempMods;
import com.fs.starfarer.api.combat.StatBonus;
import com.fs.starfarer.api.fleet.MutableMarketStatsAPI;
import com.fs.starfarer.api.fleet.ShipFilter;
import com.fs.starfarer.api.fleet.ShipRolePick;
import com.fs.starfarer.api.impl.campaign.econ.impl.ConstructionQueue;
import com.fs.starfarer.api.impl.campaign.population.PopulationComposition;
 
public interface MarketAPI extends HasMemory {
    
    public static enum MarketInteractionMode {
        LOCAL,
        REMOTE,
    }
    
    public static enum SurveyLevel {
        NONE,
        SEEN,
        PRELIMINARY,
        FULL
    }
    
    SectorEntityToken getPrimaryEntity();
    Set<SectorEntityToken> getConnectedEntities();
    
    String getId();
    String getName();
    int getSize();
    
    //Vector2f getLocation();
    
    void setSize(int size);
    
    List<CommodityOnMarketAPI> getAllCommodities();
    CommodityOnMarketAPI getCommodityData(String commodityId);
    List<CommodityOnMarketAPI> getCommoditiesWithTag(String tag);
    List<CommodityOnMarketAPI> getCommoditiesWithTags(String ... tags);
    
    MarketDemandAPI getDemand(String demandClass);
    List<MarketDemandAPI> getDemandWithTag(String tag);
 
    List<MarketConditionAPI> getConditions();
    String addCondition(String id);
    
    String addCondition(String id, Object param);
    
    void removeCondition(String id);
    
    void removeSpecificCondition(String token);
    
    boolean hasCondition(String id);
    boolean hasSpecificCondition(String token);
    void reapplyConditions();
    void reapplyCondition(String token);
    
    MarketDemandDataAPI getDemandData();
    
//  StabilityTrackerAPI getStabilityTracker();
    
    MutableStat getTariff();
    
    StatBonus getDemandPriceMod();
    
    StatBonus getSupplyPriceMod();
    
    
    float getSupplyPrice(String commodityId, double quantity, boolean isPlayerPrice);
    
    
    float getDemandPrice(String commodityId, double quantity, boolean isPlayerPrice);
    
    
    float getDemandPriceAssumingExistingTransaction(String commodityId, double quantity, double existingTransactionUtility, boolean isPlayerPrice);
    
    float getSupplyPriceAssumingExistingTransaction(String commodityId, double quantity, double existingTransactionUtility, boolean isPlayerPrice);
    
    boolean isIllegal(String commodityId);
    
    boolean isIllegal(CommodityOnMarketAPI com);
    
    MutableStatWithTempMods getStability();
    
    float getStabilityValue();
    
    FactionAPI getFaction();
    String getFactionId();
    
    void addSubmarket(String specId);
    boolean hasSubmarket(String specId);
    List<SubmarketAPI> getSubmarketsCopy();
    void removeSubmarket(String specId);
    SubmarketAPI getSubmarket(String specId);
    void setFactionId(String factionId);
    
    
    void updatePriceMult();
    MemoryAPI getMemory();
    
    MemoryAPI getMemoryWithoutUpdate();
 
    float pickShipAndAddToFleet(String role, ShipPickParams params, CampaignFleetAPI fleet);
    
    float pickShipAndAddToFleet(String role, String factionId, ShipPickParams params, CampaignFleetAPI fleet);
    
    float getShipQualityFactor();
    
    
    StarSystemAPI getStarSystem();
    LocationAPI getContainingLocation();
    
    
    Vector2f getLocationInHyperspace();
    void setPrimaryEntity(SectorEntityToken primaryEntity);
 
    
//  /**
//   * Will be null unless inited. Repeated invocations will do nothing.
//   */
//  void initCommDirectory();
 
    CommDirectoryAPI getCommDirectory();
 
    void addPerson(PersonAPI person);
    void removePerson(PersonAPI person);
    List<PersonAPI> getPeopleCopy();
    MutableMarketStatsAPI getStats();
    
    List<ShipRolePick> pickShipsForRole(String role, ShipPickParams params,
            Random random, ShipFilter filter);
    List<ShipRolePick> pickShipsForRole(String role, String factionId, ShipPickParams params, Random random, ShipFilter filter);
    
    
    boolean isPlanetConditionMarketOnly();
    void setPlanetConditionMarketOnly(boolean isPlanetConditionMarketOnly);
    void setName(String name);
    MutableStat getHazard();
    
    float getHazardValue();
    
//  boolean isSurveyed();
//  void setSurveyed(boolean surveyed);
    PlanetAPI getPlanetEntity();
    
    SurveyLevel getSurveyLevel();
    void setSurveyLevel(SurveyLevel surveyLevel);
    
    
    void advance(float amount);
    boolean isForceNoConvertOnSave();
    void setForceNoConvertOnSave(boolean forceNoConvertOnSave);
    void updatePrices();
    
    MarketConditionAPI getSpecificCondition(String token);
    
    
    MarketConditionAPI getFirstCondition(String id);
    boolean isInEconomy();
    
    List<Industry> getIndustries();
    void addIndustry(String id);
    
    void removeIndustry(String id, MarketInteractionMode mode, boolean forUpgrade);
    void reapplyIndustries();
    
    Vector2f getLocation();
    
    Industry getIndustry(String id);
    
    boolean hasIndustry(String id);
    List<CommodityOnMarketAPI> getCommoditiesCopy();
    MarketConditionAPI getCondition(String id);
    
    float getIndustryUpkeep();
    float getIndustryIncome();
    boolean hasWaystation();
    Industry instantiateIndustry(String id);
    MarketAPI clone();
    void clearCommodities();
    boolean isPlayerOwned();
    void setPlayerOwned(boolean playerOwned);
    float getPrevStability();
    float getExportIncome(boolean withOverhead);
    float getNetIncome();
    MutableStat getIncomeMult();
    MutableStat getUpkeepMult();
    PopulationComposition getPopulation();
    PopulationComposition getIncoming();
    void setPopulation(PopulationComposition population);
    void setIncoming(PopulationComposition incoming);
//  StatBonus getIncomingImmigrationMod();
//  StatBonus getOutgoingImmigrationMod();
    
    LinkedHashSet<MarketImmigrationModifier> getImmigrationModifiers();
    LinkedHashSet<MarketImmigrationModifier> getTransientImmigrationModifiers();
    void addImmigrationModifier(MarketImmigrationModifier mod);
    void removeImmigrationModifier(MarketImmigrationModifier mod);
    void addTransientImmigrationModifier(MarketImmigrationModifier mod);
    void removeTransientImmigrationModifier(MarketImmigrationModifier mod);
    List<MarketImmigrationModifier> getAllImmigrationModifiers();
    
//  boolean isAllowImport();
//  void setAllowImport(boolean allowImport);
//  boolean isAllowExport();
//  void setAllowExport(boolean allowExport);
    
    float getIncentiveCredits();
    void setIncentiveCredits(float incentiveCredits);
    
    boolean isImmigrationIncentivesOn();
    void setImmigrationIncentivesOn(Boolean incentivesOn);
    
    
    boolean isFreePort();
    void setFreePort(boolean freePort);
    boolean isImmigrationClosed();
    void setImmigrationClosed(boolean closed);
    boolean wasIncomingSetBefore();
    void addCondition(MarketConditionAPI mc);
    
    PersonAPI getAdmin();
    void setAdmin(PersonAPI admin);
    float getDaysInExistence();
    void setDaysInExistence(float daysInExistence);
    StatBonus getAccessibilityMod();
    boolean hasSpaceport();
    void setHasSpaceport(boolean hasSpaceport);
    void setHasWaystation(boolean hasWaystation);
    
    String getEconGroup();
    
    void setEconGroup(String econGroup);
    
    void addIndustry(String id, List<String> params);
    boolean hasTag(String tag);
    void addTag(String tag);
    void removeTag(String tag);
    Collection<String> getTags();
    void clearTags();
    String getOnOrAt();
    
    Color getTextColorForFactionOrPlanet();
    Color getDarkColorForFactionOrPlanet();
    
    boolean isHidden();
    
    void setHidden(Boolean hidden);
    
    boolean isUseStockpilesForShortages();
    void setUseStockpilesForShortages(boolean useStockpilesForShortages);
    float getShortageCounteringCost();
    void addSubmarket(SubmarketAPI submarket);
    ConstructionQueue getConstructionQueue();
    boolean isInHyperspace();
    
    LinkedHashSet<String> getSuppressedConditions();
    boolean isConditionSuppressed(String id);
    void suppressCondition(String id);
    void unsuppressCondition(String id);
    float getImmigrationIncentivesCost();
    boolean isInvalidMissionTarget();
    void setInvalidMissionTarget(Boolean invalidMissionTarget);
    void setSuppressedConditions(LinkedHashSet<String> suppressedConditions);
    void setRetainSuppressedConditionsSetWhenEmpty(Boolean retainSuppressedConditionsSetWhenEmpty);
    float getGrossIncome();
    boolean hasFunctionalIndustry(String id);
}