com.fs.starfarer.api

Interface SettingsAPI

public interface SettingsAPI

Method Summary

Modifier and Type	Method and Description
void	addCommodityInfoToTooltip(TooltipMakerAPI tooltip, float initPad, CommoditySpecAPI spec, int max, boolean withText, boolean withSell, boolean withBuy)
void	addDefaultEntryForRole(java.lang.String role, java.lang.String variantId, float weight)
void	addEntryForRole(java.lang.String factionId, java.lang.String role, java.lang.String variantId, float weight)
int	computeNumFighterBays(ShipVariantAPI variant)
float	computeStringWidth(java.lang.String in, java.lang.String font)
FactionAPI	createBaseFaction(java.lang.String factionId) Should be used when faction data needs to be accessed outside the campaign.
CargoStackAPI	createCargoStack(CargoAPI.CargoItemType type, java.lang.Object data, CargoAPI cargo)
ButtonAPI	createCheckbox(java.lang.String text, ButtonAPI.UICheckboxSize size)
ButtonAPI	createCheckbox(java.lang.String text, java.lang.String font, java.awt.Color checkColor, ButtonAPI.UICheckboxSize size)
CustomPanelAPI	createCustom(float width, float height, CustomUIPanelPlugin plugin)
ShipAIPlugin	createDefaultShipAI(ShipAPI ship, ShipAIConfig config)
ShipVariantAPI	createEmptyVariant(java.lang.String hullVariantId, ShipHullSpecAPI hullSpec)
FleetMemberAPI	createFleetMember(FleetMemberType type, ShipVariantAPI variant)
FleetMemberAPI	createFleetMember(FleetMemberType type, java.lang.String variantOrWingId)
LabelAPI	createLabel(java.lang.String text, java.lang.String font)
SectorEntityToken	createLocationToken(float x, float y)
PersonAPI	createPerson() Can be used outside the campaign, unlike FactoryAPI.createPerson().
TextFieldAPI	createTextField(java.lang.String text, java.lang.String font)
WeaponSlotAPI	createWeaponSlot(java.lang.String id, WeaponAPI.WeaponType weaponType, WeaponAPI.WeaponSize slotSize, java.lang.String slotTypeStr, java.lang.String nodeId, org.lwjgl.util.vector.Vector2f nodePos, float angle, float arc)
void	deleteTextFileFromCommon(java.lang.String filename)
boolean	doesVariantExist(java.lang.String variantId)
boolean	fileExistsInCommon(java.lang.String filename)
void	forceMipmapsFor(java.lang.String filename, boolean forceMipmaps)
int	getAASamples()
AbilitySpecAPI	getAbilitySpec(java.lang.String abilityId)
java.util.List<WeaponSpecAPI>	getActuallyAllWeaponSpecs() Includes SYSTEM weapons and, well, everything.
java.util.List<BarEventSpec>	getAllBarEventSpecs()
java.util.List<CommoditySpecAPI>	getAllCommoditySpecs()
java.util.List<FactionSpecAPI>	getAllFactionSpecs()
java.util.List<FighterWingSpecAPI>	getAllFighterWingSpecs()
java.util.List<HullModSpecAPI>	getAllHullModSpecs()
java.util.List<IndustrySpecAPI>	getAllIndustrySpecs()
java.util.List<MarketConditionSpecAPI>	getAllMarketConditionSpecs()
java.util.List<PersonMissionSpec>	getAllMissionSpecs()
java.util.List<PlanetSpecAPI>	getAllPlanetSpecs()
java.util.List<ShipHullSpecAPI>	getAllShipHullSpecs()
java.util.List<ShipSystemSpecAPI>	getAllShipSystemSpecs()
java.util.List<SpecialItemSpecAPI>	getAllSpecialItemSpecs()
<T> java.util.Collection<T>	getAllSpecs(java.lang.Class<T> c)
java.util.List<SubmarketSpecAPI>	getAllSubmarketSpecs()
java.util.List<TerrainSpecAPI>	getAllTerrainSpecs()
java.util.List<java.lang.String>	getAllVariantIds()
java.util.List<WeaponSpecAPI>	getAllWeaponSpecs()
float	getAngleInDegreesFast(org.lwjgl.util.vector.Vector2f v)
float	getAngleInDegreesFast(org.lwjgl.util.vector.Vector2f from, org.lwjgl.util.vector.Vector2f to)
java.util.List<java.lang.String>	getAptitudeIds()
BarEventSpec	getBarEventSpec(java.lang.String id)
float	getBaseFleetSelectionRadius()
java.awt.Color	getBasePlayerColor()
float	getBaseTravelSpeed()
int	getBattleSize()
float	getBonusXP(java.lang.String key)
boolean	getBoolean(java.lang.String key)
java.awt.Color	getBrightPlayerColor()
int	getCodeFor(java.lang.String key)
java.awt.Color	getColor(java.lang.String id)
CommoditySpecAPI	getCommoditySpec(java.lang.String commodityId)
java.lang.String	getControlDescriptionForEnumName(java.lang.String name)
java.lang.String	getControlStringForAbilitySlot(int index)
java.lang.String	getControlStringForEnumName(java.lang.String name) Total hack instead of moving the Controls enum out to the .api project.
CombatReadinessPlugin	getCRPlugin()
GameState	getCurrentState()
CustomEntitySpecAPI	getCustomEntitySpec(java.lang.String id)
java.awt.Color	getDarkPlayerColor()
java.util.List<RoleEntryAPI>	getDefaultEntriesForRole(java.lang.String role)
Description	getDescription(java.lang.String id, Description.Type type) Gets entry from descriptions.csv.
java.awt.Color	getDesignTypeColor(java.lang.String designType)
java.util.List<RoleEntryAPI>	getEntriesForRole(java.lang.String factionId, java.lang.String role)
EventSpecAPI	getEventSpec(java.lang.String eventId)
FactionSpecAPI	getFactionSpec(java.lang.String id)
FighterWingSpecAPI	getFighterWingSpec(java.lang.String wingId)
float	getFleetSelectionRadiusPerUnitSize()
float	getFloat(java.lang.String key)
float	getFloatFromArray(java.lang.String key, int index)
float	getFriendlyFireDanger(ShipAPI shooter, CombatEntityAPI target, org.lwjgl.util.vector.Vector2f from, org.lwjgl.util.vector.Vector2f to, float weaponSpeed, float burstFireDuration, float weaponRange)
java.lang.String	getGameVersion() Returns e.g.
ListMap<java.lang.String>	getHullIdToVariantListMap() For default ship roles.
HullModSpecAPI	getHullModSpec(java.lang.String modId)
ShipHullSpecAPI	getHullSpec(java.lang.String hullId)
java.util.Set<java.lang.String>	getIndustryDemand(java.lang.String industryId)
IndustrySpecAPI	getIndustrySpec(java.lang.String industryId)
java.util.Set<java.lang.String>	getIndustrySupply(java.lang.String industryId)
java.lang.Object	getInstanceOfScript(java.lang.String className)
int	getInt(java.lang.String key)
int	getIntFromArray(java.lang.String key, int index)
org.json.JSONArray	getJSONArray(java.lang.String key)
org.json.JSONObject	getJSONObject(java.lang.String key)
LevelupPlugin	getLevelupPlugin()
MarketConditionSpecAPI	getMarketConditionSpec(java.lang.String conditionId)
float	getMaxArmorDamageReduction()
float	getMaxFleetSelectionRadius()
int	getMaxSensorRange()
int	getMaxSensorRange(LocationAPI loc)
int	getMaxSensorRangeHyper()
int	getMaxShipsInFleet()
org.json.JSONObject	getMergedJSON(java.lang.String path)
org.json.JSONObject	getMergedJSONForMod(java.lang.String path, java.lang.String masterMod)
org.json.JSONArray	getMergedSpreadsheetData(java.lang.String idColumn, java.lang.String path)
org.json.JSONArray	getMergedSpreadsheetDataForMod(java.lang.String idColumn, java.lang.String path, java.lang.String masterMod) Useful for building a mod that allows other mods to override some of its data.
float	getMinArmorFraction()
int	getMissionScore(java.lang.String id)
PersonMissionSpec	getMissionSpec(java.lang.String id)
ModManagerAPI	getModManager()
int	getMouseX() Converted to virtual screen coordinates, i.e.
int	getMouseY() Converted to virtual screen coordinates, i.e.
java.lang.Object	getNewPluginInstance(java.lang.String id)
java.lang.String	getNextCoolGreekLetter(java.lang.Object context)
java.lang.String	getNextGreekLetter(java.lang.Object context)
PersonalityAPI	getPersonaltySpec(java.lang.String id)
java.lang.Object	getPlugin(java.lang.String id) Plugins returned by this method are cached and persistent across multiple saves.
java.lang.String	getRoman(int n)
float	getSafeMovementDir(ShipAPI ship)
float	getScreenHeight() Virtual pixels, i.e.
float	getScreenHeightPixels()
float	getScreenScaleMult()
float	getScreenWidth() Virtual pixels, i.e.
float	getScreenWidthPixels()
java.lang.ClassLoader	getScriptClassLoader()
float	getSensorRangeMax()
float	getSensorRangeMaxHyper()
org.json.JSONObject	getSettingsJSON()
int	getShippingCapacity(MarketAPI market, boolean inFaction)
ShipSystemSpecAPI	getShipSystemSpec(java.lang.String id)
java.util.List<java.lang.String>	getSimOpponents()
java.util.List<java.lang.String>	getSimOpponentsDev()
java.util.List<java.lang.String>	getSkillIds()
SkillSpecAPI	getSkillSpec(java.lang.String skillId)
java.util.List<java.lang.String>	getSortedAbilityIds()
java.util.List<java.lang.String>	getSortedSkillIds()
java.lang.Object	getSpec(java.lang.Class c, java.lang.String id, boolean nullOnNotFound)
SpecialItemSpecAPI	getSpecialItemSpec(java.lang.String itemId)
float	getSpeedPerBurnLevel()
SpriteAPI	getSprite(SpriteId id) Same as the method that takes (String category, String key).
SpriteAPI	getSprite(java.lang.String filename) File must already have been loaded.
SpriteAPI	getSprite(java.lang.String category, java.lang.String key) Gets a sprite loaded using the "graphics" section in data/config/settings.json.
SpriteAPI	getSprite(java.lang.String category, java.lang.String id, boolean emptySpriteOnNotFound)
java.util.List<java.lang.String>	getSpriteKeys(java.lang.String category)
java.util.List<java.lang.String>	getSpriteKeys(java.lang.String category, java.lang.String listId)
java.lang.String	getSpriteName(java.lang.String category, java.lang.String id)
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String category, java.lang.String id) Gets a string from a given category in strings.json
java.util.List<WeaponSpecAPI>	getSystemWeaponSpecs()
float	getTargetingRadius(org.lwjgl.util.vector.Vector2f from, CombatEntityAPI target, boolean considerShield) Bit of a hack to have this method here.
TerrainSpecAPI	getTerrainSpec(java.lang.String terrainId)
float	getUnitsPerLightYear()
ShipVariantAPI	getVariant(java.lang.String variantId)
java.lang.String	getVersionString()
WeaponSpecAPI	getWeaponSpec(java.lang.String weaponId)
void	greekLetterReset()
boolean	hasDesignTypeColor(java.lang.String designType)
boolean	isAutoTurnMode()
boolean	isCampaignSensorsOn()
boolean	isDevMode()
boolean	isEnableShipExplosionWhiteout()
boolean	isGeneratingNewGame()
boolean	isInCampaignState()
boolean	isInGame() For modding purposes, always returns true.
boolean	isNewPlayer()
boolean	isShowDamageFloaties()
boolean	isShowingCodex()
boolean	isSoundEnabled()
boolean	isStrafeKeyAToggle()
org.json.JSONArray	loadCSV(java.lang.String filename) Returns an array of JSONObjects with keys corresponding to the columns in the csv file.
org.json.JSONArray	loadCSV(java.lang.String filename, boolean withMods)
org.json.JSONArray	loadCSV(java.lang.String filename, java.lang.String modId)
void	loadFont(java.lang.String filename)
org.json.JSONObject	loadJSON(java.lang.String filename) Use / instead of \ in paths for compatibility (required to work on OS X and Linux).
org.json.JSONObject	loadJSON(java.lang.String filename, boolean withMods)
org.json.JSONObject	loadJSON(java.lang.String filename, java.lang.String modId)
java.lang.String	loadText(java.lang.String filename) Use / instead of \ in paths for compatibility (required to work on OS X and Linux).
java.lang.String	loadText(java.lang.String filename, java.lang.String modId)
void	loadTexture(java.lang.String filename)
void	loadTextureConvertBlackToAlpha(java.lang.String filename)
java.io.InputStream	openStream(java.lang.String filename) Use / instead of \ in paths for compatibility (required to work on OS X and Linux).
boolean	optBoolean(java.lang.String key, boolean defaultValue)
ShipAIPlugin	pickShipAIPlugin(FleetMemberAPI member, ShipAPI ship)
void	profilerBegin(java.lang.String id)
void	profilerEnd()
void	profilerPrintResultsTree()
void	profilerReset()
void	profilerRestore()
void	profilerSetEnabled(boolean enabled)
void	putSpec(java.lang.Class c, java.lang.String id, java.lang.Object spec)
org.json.JSONObject	readJSONFromCommon(java.lang.String filename, boolean putInWriteCache)
java.lang.String	readTextFileFromCommon(java.lang.String filename)
void	removeDefaultEntryForRole(java.lang.String role, java.lang.String variantId)
void	removeEntryForRole(java.lang.String factionId, java.lang.String role, java.lang.String variantId)
void	resetCached() Must be called after making any changes to result of getSettingsJSON().
void	setAutoTurnMode(boolean autoTurnMode)
void	setBoolean(java.lang.String key, java.lang.Boolean value)
void	setDevMode(boolean devMode)
void	setEasySensorBonus(float easySensorBonus)
void	setEnableShipExplosionWhiteout(boolean enableShipExplosionWhiteout)
void	setFloat(java.lang.String key, java.lang.Float value)
void	showCodex(CodexEntryPlugin tempEntry)
void	showCodex(FleetMemberAPI member)
void	showCodex(java.util.List<CodexEntryPlugin> tempEntries) Will show the first entry, but will add all of the entries temporarily, until the Codex is closed.
void	showCodex(java.lang.String entryId) Can be called from anywhere.
void	unloadTexture(java.lang.String filename)
void	writeJSONToCommon(java.lang.String filename, org.json.JSONObject json, boolean onlyIfChanged)
void	writeTextFileToCommon(java.lang.String filename, java.lang.String data) Max size 1mb.

Method Detail

getBattleSize

int getBattleSize()

isShowingCodex

boolean isShowingCodex()

createPerson

PersonAPI createPerson()

Can be used outside the campaign, unlike FactoryAPI.createPerson().

Returns:

createCargoStack

CargoStackAPI createCargoStack(CargoAPI.CargoItemType type,
                               java.lang.Object data,
                               CargoAPI cargo)

createLabel

LabelAPI createLabel(java.lang.String text,
                     java.lang.String font)

getBonusXP

float getBonusXP(java.lang.String key)

getFloat

float getFloat(java.lang.String key)

getBoolean

boolean getBoolean(java.lang.String key)

optBoolean

boolean optBoolean(java.lang.String key,
                   boolean defaultValue)

getScriptClassLoader

java.lang.ClassLoader getScriptClassLoader()

isCampaignSensorsOn

boolean isCampaignSensorsOn()

isDevMode

boolean isDevMode()

setDevMode

void setDevMode(boolean devMode)

getColor

java.awt.Color getColor(java.lang.String id)

getInstanceOfScript

java.lang.Object getInstanceOfScript(java.lang.String className)

getString

java.lang.String getString(java.lang.String category,
                           java.lang.String id)

Gets a string from a given category in strings.json

Parameters:

category -

id -

Returns:

getSprite

SpriteAPI getSprite(java.lang.String filename)

File must already have been loaded. Mostly useful for retrieving ship and weapon sprites and other such.

Parameters:

filename -

Returns:

getSprite

SpriteAPI getSprite(java.lang.String category,
                    java.lang.String key)

Gets a sprite loaded using the "graphics" section in data/config/settings.json.

Parameters:

category -

key -

Returns:

getSprite

SpriteAPI getSprite(SpriteId id)

Same as the method that takes (String category, String key). SpriteId is just a container class for category + id.

Parameters:

id -

Returns:

getSpriteName

java.lang.String getSpriteName(java.lang.String category,
                               java.lang.String id)

openStream

java.io.InputStream openStream(java.lang.String filename)
                        throws java.io.IOException

Use / instead of \ in paths for compatibility (required to work on OS X and Linux).

Parameters:

filename -

Returns:

Throws:

java.io.IOException

loadText

java.lang.String loadText(java.lang.String filename)
                   throws java.io.IOException

Use / instead of \ in paths for compatibility (required to work on OS X and Linux).

Parameters:

filename -

Returns:

Throws:

java.io.IOException

loadJSON

org.json.JSONObject loadJSON(java.lang.String filename)
                      throws java.io.IOException,
                             org.json.JSONException

Use / instead of \ in paths for compatibility (required to work on OS X and Linux).

Parameters:

filename -

Returns:

Throws:

java.io.IOException

org.json.JSONException

loadCSV

org.json.JSONArray loadCSV(java.lang.String filename)
                    throws java.io.IOException,
                           org.json.JSONException

Returns an array of JSONObjects with keys corresponding to the columns in the csv file. Use / instead of \ in paths for compatibility (required to work on OS X and Linux).

Parameters:

filename -

Returns:

Throws:

java.io.IOException

org.json.JSONException

getMergedSpreadsheetDataForMod

org.json.JSONArray getMergedSpreadsheetDataForMod(java.lang.String idColumn,
                                                  java.lang.String path,
                                                  java.lang.String masterMod)
                                           throws java.io.IOException,
                                                  org.json.JSONException

Useful for building a mod that allows other mods to override some of its data. Merges on spreadsheet level only; rows with matching ids get replaced by non-master rows. If multiple non-master rows have the same id, one will be picked in an undefined manner.

Parameters:

idColumn - the column to be used as the key for merging spreadsheets.

path - the location of the spreadsheet, i.e. "mydata/spreadsheet.csv".

masterMod - name of the mod that has the master copy of the spreadsheet, which will be used as the base version to add to/modify during the merge.

Returns:

Throws:

java.io.IOException

org.json.JSONException

getMergedJSONForMod

org.json.JSONObject getMergedJSONForMod(java.lang.String path,
                                        java.lang.String masterMod)
                                 throws java.io.IOException,
                                        org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

getScreenWidth

float getScreenWidth()

Virtual pixels, i.e. divided by getScreenScaleMult().

Returns:

getScreenHeight

float getScreenHeight()

Virtual pixels, i.e. divided by getScreenScaleMult().

Returns:

getScreenWidthPixels

float getScreenWidthPixels()

getScreenHeightPixels

float getScreenHeightPixels()

getDescription

Description getDescription(java.lang.String id,
                           Description.Type type)

Gets entry from descriptions.csv.

Parameters:

id -

type -

Returns:

description, or null if not found.

getCRPlugin

CombatReadinessPlugin getCRPlugin()

getCodeFor

int getCodeFor(java.lang.String key)

getWeaponSpec

WeaponSpecAPI getWeaponSpec(java.lang.String weaponId)

loadTexture

void loadTexture(java.lang.String filename)
          throws java.io.IOException

Throws:

java.io.IOException

getTargetingRadius

float getTargetingRadius(org.lwjgl.util.vector.Vector2f from,
                         CombatEntityAPI target,
                         boolean considerShield)

Bit of a hack to have this method here. It's just a way to call into some unexposed utility code.

Parameters:

from -

target -

considerShield -

Returns:

getVariant

ShipVariantAPI getVariant(java.lang.String variantId)

getPlugin

java.lang.Object getPlugin(java.lang.String id)

Plugins returned by this method are cached and persistent across multiple saves. They should not have any data members that point at campaign data or it will cause a memory leak.

Parameters:

id -

Returns:

getSortedSkillIds

java.util.List<java.lang.String> getSortedSkillIds()

getSkillSpec

SkillSpecAPI getSkillSpec(java.lang.String skillId)

getString

java.lang.String getString(java.lang.String key)

getAbilitySpec

AbilitySpecAPI getAbilitySpec(java.lang.String abilityId)

getSortedAbilityIds

java.util.List<java.lang.String> getSortedAbilityIds()

getBaseTravelSpeed

float getBaseTravelSpeed()

getSpeedPerBurnLevel

float getSpeedPerBurnLevel()

getUnitsPerLightYear

float getUnitsPerLightYear()

getMaxShipsInFleet

int getMaxShipsInFleet()

getTerrainSpec

TerrainSpecAPI getTerrainSpec(java.lang.String terrainId)

getEventSpec

EventSpecAPI getEventSpec(java.lang.String eventId)

getCustomEntitySpec

CustomEntitySpecAPI getCustomEntitySpec(java.lang.String id)

getCurrentState

GameState getCurrentState()

getMaxSensorRange

int getMaxSensorRange()

getMaxSensorRangeHyper

int getMaxSensorRangeHyper()

getMaxSensorRange

int getMaxSensorRange(LocationAPI loc)

getAllVariantIds

java.util.List<java.lang.String> getAllVariantIds()

getAptitudeIds

java.util.List<java.lang.String> getAptitudeIds()

getSkillIds

java.util.List<java.lang.String> getSkillIds()

getLevelupPlugin

LevelupPlugin getLevelupPlugin()

getVersionString

java.lang.String getVersionString()

loadJSON

org.json.JSONObject loadJSON(java.lang.String filename,
                             java.lang.String modId)
                      throws java.io.IOException,
                             org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

loadCSV

org.json.JSONArray loadCSV(java.lang.String filename,
                           java.lang.String modId)
                    throws java.io.IOException,
                           org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

loadText

java.lang.String loadText(java.lang.String filename,
                          java.lang.String modId)
                   throws java.io.IOException,
                          org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

getModManager

ModManagerAPI getModManager()

getBaseFleetSelectionRadius

float getBaseFleetSelectionRadius()

getFleetSelectionRadiusPerUnitSize

float getFleetSelectionRadiusPerUnitSize()

getMaxFleetSelectionRadius

float getMaxFleetSelectionRadius()

getEntriesForRole

java.util.List<RoleEntryAPI> getEntriesForRole(java.lang.String factionId,
                                               java.lang.String role)

addEntryForRole

void addEntryForRole(java.lang.String factionId,
                     java.lang.String role,
                     java.lang.String variantId,
                     float weight)

removeEntryForRole

void removeEntryForRole(java.lang.String factionId,
                        java.lang.String role,
                        java.lang.String variantId)

getDefaultEntriesForRole

java.util.List<RoleEntryAPI> getDefaultEntriesForRole(java.lang.String role)

addDefaultEntryForRole

void addDefaultEntryForRole(java.lang.String role,
                            java.lang.String variantId,
                            float weight)

removeDefaultEntryForRole

void removeDefaultEntryForRole(java.lang.String role,
                               java.lang.String variantId)

profilerBegin

void profilerBegin(java.lang.String id)

profilerEnd

void profilerEnd()

profilerPrintResultsTree

void profilerPrintResultsTree()

getAllPlanetSpecs

java.util.List<PlanetSpecAPI> getAllPlanetSpecs()

getSpec

java.lang.Object getSpec(java.lang.Class c,
                         java.lang.String id,
                         boolean nullOnNotFound)

putSpec

void putSpec(java.lang.Class c,
             java.lang.String id,
             java.lang.Object spec)

getAllSpecs

<T> java.util.Collection<T> getAllSpecs(java.lang.Class<T> c)

getRoman

java.lang.String getRoman(int n)

Parameters:

n - 1 to 3999.

Returns:

greekLetterReset

void greekLetterReset()

getNextCoolGreekLetter

java.lang.String getNextCoolGreekLetter(java.lang.Object context)

getNextGreekLetter

java.lang.String getNextGreekLetter(java.lang.Object context)

getMarketConditionSpec

MarketConditionSpecAPI getMarketConditionSpec(java.lang.String conditionId)

createDefaultShipAI

ShipAIPlugin createDefaultShipAI(ShipAPI ship,
                                 ShipAIConfig config)

getHullModSpec

HullModSpecAPI getHullModSpec(java.lang.String modId)

getFighterWingSpec

FighterWingSpecAPI getFighterWingSpec(java.lang.String wingId)

getAllHullModSpecs

java.util.List<HullModSpecAPI> getAllHullModSpecs()

getAllFighterWingSpecs

java.util.List<FighterWingSpecAPI> getAllFighterWingSpecs()

getAllWeaponSpecs

java.util.List<WeaponSpecAPI> getAllWeaponSpecs()

getActuallyAllWeaponSpecs

java.util.List<WeaponSpecAPI> getActuallyAllWeaponSpecs()

Includes SYSTEM weapons and, well, everything.

Returns:

isSoundEnabled

boolean isSoundEnabled()

isInCampaignState

boolean isInCampaignState()

isGeneratingNewGame

boolean isGeneratingNewGame()

getAngleInDegreesFast

float getAngleInDegreesFast(org.lwjgl.util.vector.Vector2f v)

getAngleInDegreesFast

float getAngleInDegreesFast(org.lwjgl.util.vector.Vector2f from,
                            org.lwjgl.util.vector.Vector2f to)

getCommoditySpec

CommoditySpecAPI getCommoditySpec(java.lang.String commodityId)

getHullSpec

ShipHullSpecAPI getHullSpec(java.lang.String hullId)

getFactionSpec

FactionSpecAPI getFactionSpec(java.lang.String id)

computeNumFighterBays

int computeNumFighterBays(ShipVariantAPI variant)

isInGame

boolean isInGame()

For modding purposes, always returns true.

Returns:

getNewPluginInstance

java.lang.Object getNewPluginInstance(java.lang.String id)

getControlStringForAbilitySlot

java.lang.String getControlStringForAbilitySlot(int index)

getControlStringForEnumName

java.lang.String getControlStringForEnumName(java.lang.String name)

Total hack instead of moving the Controls enum out to the .api project. Use at own peril.

Parameters:

name -

Returns:

isNewPlayer

boolean isNewPlayer()

getIndustrySpec

IndustrySpecAPI getIndustrySpec(java.lang.String industryId)

getAllCommoditySpecs

java.util.List<CommoditySpecAPI> getAllCommoditySpecs()

getInt

int getInt(java.lang.String key)

getAllIndustrySpecs

java.util.List<IndustrySpecAPI> getAllIndustrySpecs()

getSpecialItemSpec

SpecialItemSpecAPI getSpecialItemSpec(java.lang.String itemId)

getAllSpecialItemSpecs

java.util.List<SpecialItemSpecAPI> getAllSpecialItemSpecs()

getAllShipHullSpecs

java.util.List<ShipHullSpecAPI> getAllShipHullSpecs()

getSprite

SpriteAPI getSprite(java.lang.String category,
                    java.lang.String id,
                    boolean emptySpriteOnNotFound)

createEmptyVariant

ShipVariantAPI createEmptyVariant(java.lang.String hullVariantId,
                                  ShipHullSpecAPI hullSpec)

getHullIdToVariantListMap

ListMap<java.lang.String> getHullIdToVariantListMap()

For default ship roles.

Returns:

readTextFileFromCommon

java.lang.String readTextFileFromCommon(java.lang.String filename)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeTextFileToCommon

void writeTextFileToCommon(java.lang.String filename,
                           java.lang.String data)
                    throws java.io.IOException

Max size 1mb.

Parameters:

filename -

data -

Throws:

java.io.IOException

fileExistsInCommon

boolean fileExistsInCommon(java.lang.String filename)

deleteTextFileFromCommon

void deleteTextFileFromCommon(java.lang.String filename)

getBasePlayerColor

java.awt.Color getBasePlayerColor()

getDesignTypeColor

java.awt.Color getDesignTypeColor(java.lang.String designType)

doesVariantExist

boolean doesVariantExist(java.lang.String variantId)

addCommodityInfoToTooltip

void addCommodityInfoToTooltip(TooltipMakerAPI tooltip,
                               float initPad,
                               CommoditySpecAPI spec,
                               int max,
                               boolean withText,
                               boolean withSell,
                               boolean withBuy)

getJSONObject

org.json.JSONObject getJSONObject(java.lang.String key)
                           throws org.json.JSONException

Throws:

org.json.JSONException

getJSONArray

org.json.JSONArray getJSONArray(java.lang.String key)
                         throws org.json.JSONException

Throws:

org.json.JSONException

createBaseFaction

FactionAPI createBaseFaction(java.lang.String factionId)

Should be used when faction data needs to be accessed outside the campaign.

Parameters:

factionId -

Returns:

getAllMarketConditionSpecs

java.util.List<MarketConditionSpecAPI> getAllMarketConditionSpecs()

getAllSubmarketSpecs

java.util.List<SubmarketSpecAPI> getAllSubmarketSpecs()

getMinArmorFraction

float getMinArmorFraction()

getMaxArmorDamageReduction

float getMaxArmorDamageReduction()

getShipSystemSpec

ShipSystemSpecAPI getShipSystemSpec(java.lang.String id)

getAllShipSystemSpecs

java.util.List<ShipSystemSpecAPI> getAllShipSystemSpecs()

getScreenScaleMult

float getScreenScaleMult()

getAASamples

int getAASamples()

getMouseX

int getMouseX()

Converted to virtual screen coordinates, i.e. adjusted for screen scaling.

Returns:

getMouseY

int getMouseY()

Converted to virtual screen coordinates, i.e. adjusted for screen scaling.

Returns:

getShippingCapacity

int getShippingCapacity(MarketAPI market,
                        boolean inFaction)

getSettingsJSON

org.json.JSONObject getSettingsJSON()

resetCached

void resetCached()

Must be called after making any changes to result of getSettingsJSON().

setFloat

void setFloat(java.lang.String key,
              java.lang.Float value)

setBoolean

void setBoolean(java.lang.String key,
                java.lang.Boolean value)

getAllMissionSpecs

java.util.List<PersonMissionSpec> getAllMissionSpecs()

getMissionSpec

PersonMissionSpec getMissionSpec(java.lang.String id)

getAllBarEventSpecs

java.util.List<BarEventSpec> getAllBarEventSpecs()

getBarEventSpec

BarEventSpec getBarEventSpec(java.lang.String id)

setAutoTurnMode

void setAutoTurnMode(boolean autoTurnMode)

isAutoTurnMode

boolean isAutoTurnMode()

isShowDamageFloaties

boolean isShowDamageFloaties()

getFloatFromArray

float getFloatFromArray(java.lang.String key,
                        int index)

getIntFromArray

int getIntFromArray(java.lang.String key,
                    int index)

loadTextureConvertBlackToAlpha

void loadTextureConvertBlackToAlpha(java.lang.String filename)
                             throws java.io.IOException

Throws:

java.io.IOException

getControlDescriptionForEnumName

java.lang.String getControlDescriptionForEnumName(java.lang.String name)

pickShipAIPlugin

ShipAIPlugin pickShipAIPlugin(FleetMemberAPI member,
                              ShipAPI ship)

unloadTexture

void unloadTexture(java.lang.String filename)

profilerSetEnabled

void profilerSetEnabled(boolean enabled)

profilerReset

void profilerReset()

profilerRestore

void profilerRestore()

getBrightPlayerColor

java.awt.Color getBrightPlayerColor()

getDarkPlayerColor

java.awt.Color getDarkPlayerColor()

forceMipmapsFor

void forceMipmapsFor(java.lang.String filename,
                     boolean forceMipmaps)
              throws java.io.IOException

Throws:

java.io.IOException

getGameVersion

java.lang.String getGameVersion()

Returns e.g. "0.95a-RC12"

Returns:

computeStringWidth

float computeStringWidth(java.lang.String in,
                         java.lang.String font)

createTextField

TextFieldAPI createTextField(java.lang.String text,
                             java.lang.String font)

createCheckbox

ButtonAPI createCheckbox(java.lang.String text,
                         ButtonAPI.UICheckboxSize size)

createCheckbox

ButtonAPI createCheckbox(java.lang.String text,
                         java.lang.String font,
                         java.awt.Color checkColor,
                         ButtonAPI.UICheckboxSize size)

createCustom

CustomPanelAPI createCustom(float width,
                            float height,
                            CustomUIPanelPlugin plugin)

getMissionScore

int getMissionScore(java.lang.String id)

createWeaponSlot

WeaponSlotAPI createWeaponSlot(java.lang.String id,
                               WeaponAPI.WeaponType weaponType,
                               WeaponAPI.WeaponSize slotSize,
                               java.lang.String slotTypeStr,
                               java.lang.String nodeId,
                               org.lwjgl.util.vector.Vector2f nodePos,
                               float angle,
                               float arc)

getMergedSpreadsheetData

org.json.JSONArray getMergedSpreadsheetData(java.lang.String idColumn,
                                            java.lang.String path)
                                     throws java.io.IOException,
                                            org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

getMergedJSON

org.json.JSONObject getMergedJSON(java.lang.String path)
                           throws java.io.IOException,
                                  org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

setEasySensorBonus

void setEasySensorBonus(float easySensorBonus)

isEnableShipExplosionWhiteout

boolean isEnableShipExplosionWhiteout()

setEnableShipExplosionWhiteout

void setEnableShipExplosionWhiteout(boolean enableShipExplosionWhiteout)

getSystemWeaponSpecs

java.util.List<WeaponSpecAPI> getSystemWeaponSpecs()

getSpriteKeys

java.util.List<java.lang.String> getSpriteKeys(java.lang.String category)

getSpriteKeys

java.util.List<java.lang.String> getSpriteKeys(java.lang.String category,
                                               java.lang.String listId)

loadJSON

org.json.JSONObject loadJSON(java.lang.String filename,
                             boolean withMods)
                      throws java.io.IOException,
                             org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

loadCSV

org.json.JSONArray loadCSV(java.lang.String filename,
                           boolean withMods)
                    throws java.io.IOException,
                           org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

getSensorRangeMaxHyper

float getSensorRangeMaxHyper()

getSensorRangeMax

float getSensorRangeMax()

loadFont

void loadFont(java.lang.String filename)
       throws java.io.IOException

Throws:

java.io.IOException

isStrafeKeyAToggle

boolean isStrafeKeyAToggle()

getAllFactionSpecs

java.util.List<FactionSpecAPI> getAllFactionSpecs()

getPersonaltySpec

PersonalityAPI getPersonaltySpec(java.lang.String id)

writeJSONToCommon

void writeJSONToCommon(java.lang.String filename,
                       org.json.JSONObject json,
                       boolean onlyIfChanged)
                throws java.io.IOException,
                       org.json.JSONException

Parameters:

onlyIfChanged - should be used sparingly, for something where the file size is fairly small and the writes are common/time sensitive. If true, the write will also happen on a new thread. Can cause increased memory use if overused for large files.

Throws:

java.io.IOException

org.json.JSONException

readJSONFromCommon

org.json.JSONObject readJSONFromCommon(java.lang.String filename,
                                       boolean putInWriteCache)
                                throws java.io.IOException,
                                       org.json.JSONException

Parameters:

putInWriteCache - should only be set to true for files you intend to call writeJSONToCommon() for with onlyIfChanged == true. Otherwise, causes unnecessary memory use.

Throws:

java.io.IOException

org.json.JSONException

getSimOpponents

java.util.List<java.lang.String> getSimOpponents()

getSimOpponentsDev

java.util.List<java.lang.String> getSimOpponentsDev()

getIndustrySupply

java.util.Set<java.lang.String> getIndustrySupply(java.lang.String industryId)

Returns:

Set of commodity ids, no quantity information.

getIndustryDemand

java.util.Set<java.lang.String> getIndustryDemand(java.lang.String industryId)

Returns:

Set of commodity ids, no quantity information.

showCodex

void showCodex(java.lang.String entryId)

Can be called from anywhere. Will do nothing if the Codex is already open.

Parameters:

entryId -

showCodex

void showCodex(CodexEntryPlugin tempEntry)

showCodex

void showCodex(java.util.List<CodexEntryPlugin> tempEntries)

Will show the first entry, but will add all of the entries temporarily, until the Codex is closed.

Parameters:

tempEntries -

showCodex

void showCodex(FleetMemberAPI member)

createFleetMember

FleetMemberAPI createFleetMember(FleetMemberType type,
                                 java.lang.String variantOrWingId)

createFleetMember

FleetMemberAPI createFleetMember(FleetMemberType type,
                                 ShipVariantAPI variant)

getAllTerrainSpecs

java.util.List<TerrainSpecAPI> getAllTerrainSpecs()

createLocationToken

SectorEntityToken createLocationToken(float x,
                                      float y)

hasDesignTypeColor

boolean hasDesignTypeColor(java.lang.String designType)

getFriendlyFireDanger

float getFriendlyFireDanger(ShipAPI shooter,
                            CombatEntityAPI target,
                            org.lwjgl.util.vector.Vector2f from,
                            org.lwjgl.util.vector.Vector2f to,
                            float weaponSpeed,
                            float burstFireDuration,
                            float weaponRange)

getSafeMovementDir

float getSafeMovementDir(ShipAPI ship)