SettingsAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api;
 
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.List;
import java.util.Set;
 
import java.awt.Color;
 
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.campaign.CargoAPI;
import com.fs.starfarer.api.campaign.CargoAPI.CargoItemType;
import com.fs.starfarer.api.campaign.CargoStackAPI;
import com.fs.starfarer.api.campaign.CustomEntitySpecAPI;
import com.fs.starfarer.api.campaign.CustomUIPanelPlugin;
import com.fs.starfarer.api.campaign.FactionAPI;
import com.fs.starfarer.api.campaign.FactionSpecAPI;
import com.fs.starfarer.api.campaign.LocationAPI;
import com.fs.starfarer.api.campaign.PlanetSpecAPI;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import com.fs.starfarer.api.campaign.SpecialItemSpecAPI;
import com.fs.starfarer.api.campaign.econ.CommoditySpecAPI;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.campaign.econ.SubmarketSpecAPI;
import com.fs.starfarer.api.characters.MarketConditionSpecAPI;
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.characters.PersonalityAPI;
import com.fs.starfarer.api.characters.SkillSpecAPI;
import com.fs.starfarer.api.combat.CombatEntityAPI;
import com.fs.starfarer.api.combat.CombatReadinessPlugin;
import com.fs.starfarer.api.combat.ShipAIConfig;
import com.fs.starfarer.api.combat.ShipAIPlugin;
import com.fs.starfarer.api.combat.ShipAPI;
import com.fs.starfarer.api.combat.ShipHullSpecAPI;
import com.fs.starfarer.api.combat.ShipSystemSpecAPI;
import com.fs.starfarer.api.combat.ShipVariantAPI;
import com.fs.starfarer.api.combat.WeaponAPI.WeaponSize;
import com.fs.starfarer.api.combat.WeaponAPI.WeaponType;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.fleet.FleetMemberType;
import com.fs.starfarer.api.graphics.SpriteAPI;
import com.fs.starfarer.api.impl.codex.CodexEntryPlugin;
import com.fs.starfarer.api.loading.AbilitySpecAPI;
import com.fs.starfarer.api.loading.BarEventSpec;
import com.fs.starfarer.api.loading.Description;
import com.fs.starfarer.api.loading.Description.Type;
import com.fs.starfarer.api.loading.EventSpecAPI;
import com.fs.starfarer.api.loading.FighterWingSpecAPI;
import com.fs.starfarer.api.loading.HullModSpecAPI;
import com.fs.starfarer.api.loading.IndustrySpecAPI;
import com.fs.starfarer.api.loading.PersonMissionSpec;
import com.fs.starfarer.api.loading.RoleEntryAPI;
import com.fs.starfarer.api.loading.TerrainSpecAPI;
import com.fs.starfarer.api.loading.WeaponSlotAPI;
import com.fs.starfarer.api.loading.WeaponSpecAPI;
import com.fs.starfarer.api.plugins.LevelupPlugin;
import com.fs.starfarer.api.ui.ButtonAPI;
import com.fs.starfarer.api.ui.ButtonAPI.UICheckboxSize;
import com.fs.starfarer.api.ui.CustomPanelAPI;
import com.fs.starfarer.api.ui.LabelAPI;
import com.fs.starfarer.api.ui.TextFieldAPI;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
import com.fs.starfarer.api.util.ListMap;
 
public interface SettingsAPI {
    int getBattleSize();
    
    boolean isShowingCodex();
    
    PersonAPI createPerson();
    
    CargoStackAPI createCargoStack(CargoItemType type, Object data, CargoAPI cargo);
    
    LabelAPI createLabel(String text, String font);
    
    float getBonusXP(String key);
    
    float getFloat(String key);
    boolean getBoolean(String key);
    boolean optBoolean(String key, boolean defaultValue);
    ClassLoader getScriptClassLoader();
    
    boolean isCampaignSensorsOn();
    
    boolean isDevMode();
    void setDevMode(boolean devMode);
    
    Color getColor(String id);
    
    Object getInstanceOfScript(String className);
    
    String getString(String category, String id);
    
    SpriteAPI getSprite(String filename);
    
    SpriteAPI getSprite(String category, String key);
    
    SpriteAPI getSprite(SpriteId id);
    
    String getSpriteName(String category, String id);
    
    InputStream openStream(String filename) throws IOException;
    
    String loadText(String filename) throws IOException;
    
    JSONObject loadJSON(String filename) throws IOException, JSONException;
    
    JSONArray loadCSV(String filename) throws IOException, JSONException;
    
    JSONArray getMergedSpreadsheetDataForMod(String idColumn, String path, String masterMod) throws IOException, JSONException;
    
    JSONObject getMergedJSONForMod(String path, String masterMod) throws IOException, JSONException;
    
    
    float getScreenWidth();
    
    float getScreenHeight();
    
    float getScreenWidthPixels();
    float getScreenHeightPixels();
    
    Description getDescription(String id, Type type);
    
    CombatReadinessPlugin getCRPlugin();
    
    int getCodeFor(String key);
    
    
    
    
    WeaponSpecAPI getWeaponSpec(String weaponId);
 
    void loadTexture(String filename) throws IOException;
 
    
    float getTargetingRadius(Vector2f from, CombatEntityAPI target, boolean considerShield);
    
    
    ShipVariantAPI getVariant(String variantId);
 
    Object getPlugin(String id);
 
    List<String> getSortedSkillIds();
    
    SkillSpecAPI getSkillSpec(String skillId);
 
    String getString(String key);
 
    AbilitySpecAPI getAbilitySpec(String abilityId);
 
    List<String> getSortedAbilityIds();
 
    float getBaseTravelSpeed();
 
    float getSpeedPerBurnLevel();
 
    float getUnitsPerLightYear();
 
    int getMaxShipsInFleet();
 
    TerrainSpecAPI getTerrainSpec(String terrainId);
    EventSpecAPI getEventSpec(String eventId);
    CustomEntitySpecAPI getCustomEntitySpec(String id);
 
    GameState getCurrentState();
 
    int getMaxSensorRange();
    int getMaxSensorRangeHyper();
    int getMaxSensorRange(LocationAPI loc);
 
    List<String> getAllVariantIds();
    List<String> getAptitudeIds();
    List<String> getSkillIds();
    LevelupPlugin getLevelupPlugin();
    String getVersionString();
 
    JSONObject loadJSON(String filename, String modId) throws IOException, JSONException;
    JSONArray loadCSV(String filename, String modId) throws IOException, JSONException;
    String loadText(String filename, String modId) throws IOException, JSONException;
 
    ModManagerAPI getModManager();
 
    float getBaseFleetSelectionRadius();
    float getFleetSelectionRadiusPerUnitSize();
    float getMaxFleetSelectionRadius();
 
    List<RoleEntryAPI> getEntriesForRole(String factionId, String role);
    void addEntryForRole(String factionId, String role, String variantId, float weight);
    void removeEntryForRole(String factionId, String role, String variantId);
 
    List<RoleEntryAPI> getDefaultEntriesForRole(String role);
    void addDefaultEntryForRole(String role, String variantId, float weight);
    void removeDefaultEntryForRole(String role, String variantId);
 
    void profilerBegin(String id);
    void profilerEnd();
    void profilerPrintResultsTree();
 
    List<PlanetSpecAPI> getAllPlanetSpecs();
 
    Object getSpec(Class c, String id, boolean nullOnNotFound);
    void putSpec(Class c, String id, Object spec);
    <T> Collection<T> getAllSpecs(Class<T> c);
 
    String getRoman(int n);
    void greekLetterReset();
    String getNextCoolGreekLetter(Object context);
    String getNextGreekLetter(Object context);
 
    MarketConditionSpecAPI getMarketConditionSpec(String conditionId);
    
    
    ShipAIPlugin createDefaultShipAI(ShipAPI ship, ShipAIConfig config);
 
    HullModSpecAPI getHullModSpec(String modId);
    FighterWingSpecAPI getFighterWingSpec(String wingId);
    List<HullModSpecAPI> getAllHullModSpecs();
    List<FighterWingSpecAPI> getAllFighterWingSpecs();
 
    List<WeaponSpecAPI> getAllWeaponSpecs();
    List<WeaponSpecAPI> getActuallyAllWeaponSpecs();
 
    boolean isSoundEnabled();
 
    boolean isInCampaignState();
 
    boolean isGeneratingNewGame();
 
    float getAngleInDegreesFast(Vector2f v);
    float getAngleInDegreesFast(Vector2f from, Vector2f to);
 
    CommoditySpecAPI getCommoditySpec(String commodityId);
 
    ShipHullSpecAPI getHullSpec(String hullId);
    
    FactionSpecAPI getFactionSpec(String id);
 
    int computeNumFighterBays(ShipVariantAPI variant);
 
    
    boolean isInGame();
 
    Object getNewPluginInstance(String id);
    String getControlStringForAbilitySlot(int index);
 
    
    String getControlStringForEnumName(String name);
 
    boolean isNewPlayer();
 
    IndustrySpecAPI getIndustrySpec(String industryId);
 
    List<CommoditySpecAPI> getAllCommoditySpecs();
 
    int getInt(String key);
 
    List<IndustrySpecAPI> getAllIndustrySpecs();
 
    SpecialItemSpecAPI getSpecialItemSpec(String itemId);
 
    List<SpecialItemSpecAPI> getAllSpecialItemSpecs();
 
    List<ShipHullSpecAPI> getAllShipHullSpecs();
 
    SpriteAPI getSprite(String category, String id, boolean emptySpriteOnNotFound);
 
    ShipVariantAPI createEmptyVariant(String hullVariantId, ShipHullSpecAPI hullSpec);
 
    ListMap<String> getHullIdToVariantListMap();
 
    
    
    String readTextFileFromCommon(String filename) throws IOException;
    
    void writeTextFileToCommon(String filename, String data) throws IOException;
 
    boolean fileExistsInCommon(String filename);
    void deleteTextFileFromCommon(String filename);
    
    Color getBasePlayerColor();
    Color getDesignTypeColor(String designType);
 
    boolean doesVariantExist(String variantId);
 
    void addCommodityInfoToTooltip(TooltipMakerAPI tooltip, float initPad, CommoditySpecAPI spec, 
                                   int max, boolean withText, boolean withSell, boolean withBuy);
 
    
    JSONObject getJSONObject(String key) throws JSONException;
    JSONArray getJSONArray(String key) throws JSONException;
 
    FactionAPI createBaseFaction(String factionId);
 
    List<MarketConditionSpecAPI> getAllMarketConditionSpecs();
    List<SubmarketSpecAPI> getAllSubmarketSpecs();
 
    float getMinArmorFraction();
 
    float getMaxArmorDamageReduction();
 
    ShipSystemSpecAPI getShipSystemSpec(String id);
    List<ShipSystemSpecAPI> getAllShipSystemSpecs();
 
    float getScreenScaleMult();
    int getAASamples();
 
    int getMouseX();
    
    int getMouseY();
 
    int getShippingCapacity(MarketAPI market, boolean inFaction);
    JSONObject getSettingsJSON();
    void resetCached();
 
    void setFloat(String key, Float value);
    void setBoolean(String key, Boolean value);
 
    List<PersonMissionSpec> getAllMissionSpecs();
    PersonMissionSpec getMissionSpec(String id);
    
    List<BarEventSpec> getAllBarEventSpecs();
    BarEventSpec getBarEventSpec(String id);
 
    void setAutoTurnMode(boolean autoTurnMode);
    boolean isAutoTurnMode();
 
    boolean isShowDamageFloaties();
 
    float getFloatFromArray(String key, int index);
 
    int getIntFromArray(String key, int index);
 
    void loadTextureConvertBlackToAlpha(String filename) throws IOException;
 
    String getControlDescriptionForEnumName(String name);
 
    ShipAIPlugin pickShipAIPlugin(FleetMemberAPI member, ShipAPI ship);
 
    void unloadTexture(String filename);
 
    void profilerSetEnabled(boolean enabled);
 
    void profilerReset();
 
    void profilerRestore();
 
    Color getBrightPlayerColor();
 
    Color getDarkPlayerColor();
 
    void forceMipmapsFor(String filename, boolean forceMipmaps) throws IOException;
 
    String getGameVersion();
 
    float computeStringWidth(String in, String font);
 
    TextFieldAPI createTextField(String text, String font);
 
    ButtonAPI createCheckbox(String text, UICheckboxSize size);
    ButtonAPI createCheckbox(String text, String font, Color checkColor, UICheckboxSize size);
 
    CustomPanelAPI createCustom(float width, float height, CustomUIPanelPlugin plugin);
 
    int getMissionScore(String id);
 
    WeaponSlotAPI createWeaponSlot(String id, WeaponType weaponType, WeaponSize slotSize, String slotTypeStr,
                                   String nodeId, Vector2f nodePos, float angle, float arc);
 
    JSONArray getMergedSpreadsheetData(String idColumn, String path) throws IOException, JSONException;
    JSONObject getMergedJSON(String path) throws IOException, JSONException;
 
    void setEasySensorBonus(float easySensorBonus);
 
    boolean isEnableShipExplosionWhiteout();
    void setEnableShipExplosionWhiteout(boolean enableShipExplosionWhiteout);
 
    List<WeaponSpecAPI> getSystemWeaponSpecs();
 
    List<String> getSpriteKeys(String category);
    List<String> getSpriteKeys(String category, String listId);
 
    JSONObject loadJSON(String filename, boolean withMods) throws IOException, JSONException;
    JSONArray loadCSV(String filename, boolean withMods) throws IOException, JSONException;
 
    float getSensorRangeMaxHyper();
    float getSensorRangeMax();
 
    void loadFont(String filename) throws IOException;
 
    boolean isStrafeKeyAToggle();
 
    List<FactionSpecAPI> getAllFactionSpecs();
 
    PersonalityAPI getPersonaltySpec(String id);
 
    void writeJSONToCommon(String filename, JSONObject json, boolean onlyIfChanged) throws IOException, JSONException;
    
    JSONObject readJSONFromCommon(String filename, boolean putInWriteCache) throws IOException, JSONException;
 
    List<String> getSimOpponents();
    List<String> getSimOpponentsDev();
    
    Set<String> getIndustrySupply(String industryId);
    
    Set<String> getIndustryDemand(String industryId);
    
    
    void showCodex(String entryId);
    void showCodex(CodexEntryPlugin tempEntry);
    
    void showCodex(List<CodexEntryPlugin> tempEntries);
    void showCodex(FleetMemberAPI member); 
    
    FleetMemberAPI createFleetMember(FleetMemberType type, String variantOrWingId);
    FleetMemberAPI createFleetMember(FleetMemberType type, ShipVariantAPI variant);
    
    List<TerrainSpecAPI> getAllTerrainSpecs();
    SectorEntityToken createLocationToken(float x, float y);
    boolean hasDesignTypeColor(String designType);
    
    public float getFriendlyFireDanger(ShipAPI shooter, CombatEntityAPI target,
              Vector2f from, Vector2f to,
              float weaponSpeed, float burstFireDuration, float weaponRange);
    public float getSafeMovementDir(ShipAPI ship);
}