com.fs.starfarer.api.campaign.FactionAPI Interface Reference

Inheritance diagram for com.fs.starfarer.api.campaign.FactionAPI:

Collaboration diagram for com.fs.starfarer.api.campaign.FactionAPI:

Classes
enum	ShipPickMode
class	ShipPickParams

Public Member Functions
void	adjustRelationship (String id, float delta)
boolean	adjustRelationship (String id, float delta, RepLevel limit)
void	setRelationship (String id, float newValue)
void	setRelationship (String id, RepLevel level)
boolean	ensureAtBest (String id, RepLevel level)
boolean	ensureAtWorst (String id, RepLevel level)
RepLevel	getRelationshipLevel (FactionAPI faction)
RepLevel	getRelationshipLevel (String id)
boolean	isAtWorst (String id, RepLevel level)
boolean	isAtWorst (FactionAPI other, RepLevel level)
boolean	isAtBest (String id, RepLevel level)
boolean	isAtBest (FactionAPI other, RepLevel level)
boolean	isHostileTo (FactionAPI other)
boolean	isHostileTo (String other)
float	getRelationship (String id)
String	getId ()
String	getDisplayName ()
String	getDisplayNameWithArticle ()
Color	getColor ()
Color	getBaseUIColor ()
Color	getGridUIColor ()
Color	getDarkUIColor ()
Color	getSecondaryUIColor ()
Color	getBrightUIColor ()
boolean	isNeutralFaction ()
boolean	isPlayerFaction ()
List< String >	getStockFleetIds ()
MemoryAPI	getMemory ()
float	pickShipAndAddToFleet (String role, ShipPickParams params, CampaignFleetAPI fleet)
String	getFleetTypeName (String type)
String	getDisplayNameLong ()
String	getDisplayNameLongWithArticle ()
String	getEntityNamePrefix ()
Color	getRelColor (String otherFactionId)
Set< String >	getIllegalCommodities ()
boolean	isIllegal (String commodityId)
boolean	isIllegal (CargoStackAPI stack)
List< ShipRolePick >	pickShip (String role, ShipPickParams params)
List< ShipRolePick >	pickShip (String role, ShipPickParams params, ShipFilter filter, Random random)
void	makeCommodityIllegal (String commodityId)
void	makeCommodityLegal (String commodityId)
float	getTariffFraction ()
float	getTollFraction ()
float	getFineFraction ()
String	getInternalCommsChannel ()
PersonAPI	createRandomPerson ()
PersonAPI	createRandomPerson (Gender gender)
String	getLogo ()
JSONObject	getCustom ()
MemoryAPI	getMemoryWithoutUpdate ()
Color	getRelColor (RepLevel level)
RelationshipAPI	getRelToPlayer ()
String	getRank (String id)
String	getPost (String id)
String	getDisplayNameIsOrAre ()
String	pickPersonality ()
boolean	getCustomBoolean (String key)
String	getCustomString (String key)
boolean	isShowInIntelTab ()
void	setShowInIntelTab (boolean isShowInIntelTab)
String	getCrest ()
String	getPersonNamePrefix ()
String	getPersonNamePrefixAOrAn ()
String	pickRandomShipName ()
float	pickShipAndAddToFleet (String role, ShipPickParams params, CampaignFleetAPI fleet, Random random)
Set< String >	getVariantsForRole (String roleId)
PersonAPI	createRandomPerson (Gender gender, Random random)
PersonAPI	createRandomPerson (Random random)
float	getCustomFloat (String key)
int	getSecondarySegments ()
String	getDisplayNameOverride ()
void	setDisplayNameOverride (String displayNameOverride)
String	getDisplayNameWithArticleOverride ()
void	setDisplayNameWithArticleOverride (String displayNameWithArticleOverride)
String	getDisplayIsOrAreOverride ()
void	setDisplayIsOrAreOverride (String displayIsOrAreOverride)
String	getShipNamePrefixOverride ()
void	setShipNamePrefixOverride (String shipNamePrefixOverride)
String	getPersonNamePrefixAOrAnOverride ()
void	setPersonNamePrefixAOrAnOverride (String personNamePrefixAOrAnOverride)
String	getFactionLogoOverride ()
void	setFactionLogoOverride (String factionLogoOverride)
String	getFactionCrestOverride ()
void	setFactionCrestOverride (String factionCrestOverride)
WeightedRandomPicker< String >	getPortraits (Gender gender)
Set< String >	getKnownShips ()
void	addKnownShip (String hullId, boolean setTimestamp)
void	removeKnownShip (String hullId)
Set< String >	getKnownWeapons ()
void	addKnownWeapon (String weaponId, boolean setTimestamp)
void	removeKnownWeapon (String weaponId)
Set< String >	getKnownFighters ()
void	addKnownFighter (String wingId, boolean setTimestamp)
void	removeKnownFighter (String wingId)
Set< String >	getKnownIndustries ()
void	addKnownIndustry (String industryId)
void	removeKnownIndustry (String industryId)
boolean	knowsShip (String hullId)
boolean	knowsWeapon (String weaponId)
boolean	knowsFighter (String wingId)
boolean	knowsIndustry (String industryId)
Set< String >	getPriorityShips ()
void	addPriorityShip (String hullId)
void	removePriorityShip (String hullId)
boolean	isShipPriority (String hullId)
Set< String >	getPriorityWeapons ()
void	addPriorityWeapon (String weaponId)
void	removePriorityWeapon (String weaponId)
boolean	isWeaponPriority (String weaponId)
Set< String >	getPriorityFighters ()
void	addPriorityFighter (String wingId)
void	removePriorityFighter (String wingId)
boolean	isFighterPriority (String wingId)
boolean	isAutoEnableKnownWeapons ()
void	setAutoEnableKnownWeapons (boolean autoEnableKnownWeapons)
boolean	isAutoEnableKnownShips ()
void	setAutoEnableKnownShips (boolean autoEnableKnownShips)
boolean	isAutoEnableKnownFighters ()
void	setAutoEnableKnownFighters (boolean autoEnableKnownFighters)
boolean	isAutoEnableKnownHullmods ()
void	setAutoEnableKnownHullmods (boolean autoEnableKnownHullmods)
void	addKnownHullMod (String modId)
void	removeKnownHullMod (String modId)
boolean	knowsHullMod (String modId)
Set< String >	getKnownHullMods ()
void	addPriorityHullMod (String modId)
void	removePriorityHullMod (String modId)
boolean	isHullModPriority (String modId)
Set< String >	getPriorityHullMods ()
FactionDoctrineAPI	getDoctrine ()
Map< String, Float >	getVariantOverrides ()
LinkedHashSet< String >	getOverriddenHulls ()
Map< String, Float >	getHullFrequency ()
Set< String >	getAlwaysKnownShips ()
void	addUseWhenImportingShip (String hullId)
void	removeUseWhenImportingShip (String hullId)
boolean	useWhenImportingShip (String hullId)
void	clearShipRoleCache ()
WeightedRandomPicker< String >	getPersonalityPicker ()
FactionProductionAPI	getProduction ()
Map< String, Long >	getWeaponTimestamps ()
Map< String, Long >	getFighterTimestamps ()
Map< String, Long >	getShipTimestamps ()
void	setShipTimestampToNow (String hullId)
void	setWeaponTimestampToNow (String weaponId)
void	setFighterTimestampToNow (String wingId)
boolean	isShipKnownAt (String hullId, Long timestamp)
boolean	isWeaponKnownAt (String weaponId, Long timestamp)
boolean	isFighterKnownAt (String wing, Long timestamp)
int	getNumAvailableForRole (String roleId, ShipPickMode mode)
String	getDisplayNameHasOrHave ()
String	getDisplayNameWithArticleWithoutArticle ()
String	pickRandomShipName (Random random)
float	getApproximateMaxFPPerFleet (ShipPickMode mode)
Map< String, String >	getMusicMap ()
String	getBarSound ()
int	getRepInt (String id)
String	pickVoice (PersonImportance importance, Random random)
String	getShipNamePrefix ()
Map< String, Float >	getWeaponSellFrequency ()
Map< String, Float >	getFighterSellFrequency ()
Map< String, Float >	getHullmodSellFrequency ()
FactionSpecAPI	getFactionSpec ()
void	initSpecIfNeeded ()
JSONObject	getCustomJSONObject (String key)
float	getVariantWeightForRole (String roleId, ShipPickMode mode)
Color	getSecondaryColorOverride ()
void	setSecondaryColorOverride (Color secondaryOverride)
int	getSecondaryColorSegmentsOverride ()
void	setSecondaryColorSegmentsOverride (int secondaryColorSegmentsOverride)

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 26 of file FactionAPI.java.

Member Function Documentation

addKnownFighter()

void com.fs.starfarer.api.campaign.FactionAPI.addKnownFighter	(	String	wingId,
		boolean	setTimestamp
	)

addKnownHullMod()

void com.fs.starfarer.api.campaign.FactionAPI.addKnownHullMod

(

String

modId

)

addKnownIndustry()

void com.fs.starfarer.api.campaign.FactionAPI.addKnownIndustry

(

String

industryId

)

addKnownShip()

void com.fs.starfarer.api.campaign.FactionAPI.addKnownShip	(	String	hullId,
		boolean	setTimestamp
	)

addKnownWeapon()

void com.fs.starfarer.api.campaign.FactionAPI.addKnownWeapon	(	String	weaponId,
		boolean	setTimestamp
	)

addPriorityFighter()

void com.fs.starfarer.api.campaign.FactionAPI.addPriorityFighter

(

String

wingId

)

addPriorityHullMod()

void com.fs.starfarer.api.campaign.FactionAPI.addPriorityHullMod

(

String

modId

)

addPriorityShip()

void com.fs.starfarer.api.campaign.FactionAPI.addPriorityShip

(

String

hullId

)

addPriorityWeapon()

void com.fs.starfarer.api.campaign.FactionAPI.addPriorityWeapon

(

String

weaponId

)

addUseWhenImportingShip()

void com.fs.starfarer.api.campaign.FactionAPI.addUseWhenImportingShip

(

String

hullId

)

adjustRelationship() [1/2]

void com.fs.starfarer.api.campaign.FactionAPI.adjustRelationship	(	String	id,
		float	delta
	)

adjustRelationship() [2/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.adjustRelationship	(	String	id,
		float	delta,
		RepLevel	limit
	)

clearShipRoleCache()

void com.fs.starfarer.api.campaign.FactionAPI.clearShipRoleCache

(

)

Should be called after direct manipulation of the faction's known/always known/priority ship hulls. Automatically called by the add/removeXXXShip methods.

createRandomPerson() [1/4]

PersonAPI com.fs.starfarer.api.campaign.FactionAPI.createRandomPerson

(

)

createRandomPerson() [2/4]

PersonAPI com.fs.starfarer.api.campaign.FactionAPI.createRandomPerson

(

Gender

gender

)

createRandomPerson() [3/4]

PersonAPI com.fs.starfarer.api.campaign.FactionAPI.createRandomPerson	(	Gender	gender,
		Random	random
	)

createRandomPerson() [4/4]

PersonAPI com.fs.starfarer.api.campaign.FactionAPI.createRandomPerson

(

Random

random

)

ensureAtBest()

boolean com.fs.starfarer.api.campaign.FactionAPI.ensureAtBest	(	String	id,
		RepLevel	level
	)

ensureAtWorst()

boolean com.fs.starfarer.api.campaign.FactionAPI.ensureAtWorst	(	String	id,
		RepLevel	level
	)

getAlwaysKnownShips()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getAlwaysKnownShips

(

)

Hulls that will be in fleets even when the market's ship & weapons supply is from another faction. Generally faction-specific skins of base hulls known to all factions.

Returns

getApproximateMaxFPPerFleet()

float com.fs.starfarer.api.campaign.FactionAPI.getApproximateMaxFPPerFleet

(

ShipPickMode

mode

)

Used to figure out how many fleet points raids/expeditions etc divide out for each "large" fleet. When going above 30 ships, fleets replace some smaller ships with larger ones. This FP limit is where that still produces fleets that aren't too top-heavy.

Returns

getBarSound()

String com.fs.starfarer.api.campaign.FactionAPI.getBarSound

(

)

getBaseUIColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getBaseUIColor

(

)

getBrightUIColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getBrightUIColor

(

)

Brighter/slightly cyan version of getBaseUIColor()

Returns

getColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getColor

(

)

getCrest()

String com.fs.starfarer.api.campaign.FactionAPI.getCrest

(

)

getCustom()

JSONObject com.fs.starfarer.api.campaign.FactionAPI.getCustom

(

)

getCustomBoolean()

boolean com.fs.starfarer.api.campaign.FactionAPI.getCustomBoolean

(

String

key

)

getCustomFloat()

float com.fs.starfarer.api.campaign.FactionAPI.getCustomFloat

(

String

key

)

getCustomJSONObject()

JSONObject com.fs.starfarer.api.campaign.FactionAPI.getCustomJSONObject

(

String

key

)

getCustomString()

String com.fs.starfarer.api.campaign.FactionAPI.getCustomString

(

String

key

)

getDarkUIColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getDarkUIColor

(

)

getDisplayIsOrAreOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayIsOrAreOverride

(

)

getDisplayName()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayName

(

)

getDisplayNameHasOrHave()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameHasOrHave

(

)

getDisplayNameIsOrAre()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameIsOrAre

(

)

getDisplayNameLong()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameLong

(

)

getDisplayNameLongWithArticle()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameLongWithArticle

(

)

getDisplayNameOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameOverride

(

)

getDisplayNameWithArticle()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameWithArticle

(

)

getDisplayNameWithArticleOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameWithArticleOverride

(

)

getDisplayNameWithArticleWithoutArticle()

String com.fs.starfarer.api.campaign.FactionAPI.getDisplayNameWithArticleWithoutArticle

(

)

getDoctrine()

FactionDoctrineAPI com.fs.starfarer.api.campaign.FactionAPI.getDoctrine

(

)

getEntityNamePrefix()

String com.fs.starfarer.api.campaign.FactionAPI.getEntityNamePrefix

(

)

getFactionCrestOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getFactionCrestOverride

(

)

getFactionLogoOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getFactionLogoOverride

(

)

getFactionSpec()

FactionSpecAPI com.fs.starfarer.api.campaign.FactionAPI.getFactionSpec

(

)

getFighterSellFrequency()

Map< String, Float > com.fs.starfarer.api.campaign.FactionAPI.getFighterSellFrequency

(

)

getFighterTimestamps()

Map< String, Long > com.fs.starfarer.api.campaign.FactionAPI.getFighterTimestamps

(

)

getFineFraction()

float com.fs.starfarer.api.campaign.FactionAPI.getFineFraction

(

)

getFleetTypeName()

String com.fs.starfarer.api.campaign.FactionAPI.getFleetTypeName

(

String

type

)

getGridUIColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getGridUIColor

(

)

getHullFrequency()

Map< String, Float > com.fs.starfarer.api.campaign.FactionAPI.getHullFrequency

(

)

getHullmodSellFrequency()

Map< String, Float > com.fs.starfarer.api.campaign.FactionAPI.getHullmodSellFrequency

(

)

getId()

String com.fs.starfarer.api.campaign.FactionAPI.getId

(

)

getIllegalCommodities()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getIllegalCommodities

(

)

getInternalCommsChannel()

String com.fs.starfarer.api.campaign.FactionAPI.getInternalCommsChannel

(

)

getKnownFighters()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getKnownFighters

(

)

getKnownHullMods()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getKnownHullMods

(

)

getKnownIndustries()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getKnownIndustries

(

)

getKnownShips()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getKnownShips

(

)

getKnownWeapons()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getKnownWeapons

(

)

getLogo()

String com.fs.starfarer.api.campaign.FactionAPI.getLogo

(

)

getMemory()

MemoryAPI com.fs.starfarer.api.campaign.FactionAPI.getMemory

(

)

getMemoryWithoutUpdate()

MemoryAPI com.fs.starfarer.api.campaign.FactionAPI.getMemoryWithoutUpdate

(

)

getMusicMap()

Map< String, String > com.fs.starfarer.api.campaign.FactionAPI.getMusicMap

(

)

getNumAvailableForRole()

int com.fs.starfarer.api.campaign.FactionAPI.getNumAvailableForRole	(	String	roleId,
		ShipPickMode	mode
	)

getOverriddenHulls()

LinkedHashSet< String > com.fs.starfarer.api.campaign.FactionAPI.getOverriddenHulls

(

)

Hulls that are restricted to specific variants, defined in "variantOverrides" section of the .faction file.

Returns

getPersonalityPicker()

WeightedRandomPicker< String > com.fs.starfarer.api.campaign.FactionAPI.getPersonalityPicker

(

)

getPersonNamePrefix()

String com.fs.starfarer.api.campaign.FactionAPI.getPersonNamePrefix

(

)

getPersonNamePrefixAOrAn()

String com.fs.starfarer.api.campaign.FactionAPI.getPersonNamePrefixAOrAn

(

)

getPersonNamePrefixAOrAnOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getPersonNamePrefixAOrAnOverride

(

)

getPortraits()

WeightedRandomPicker< String > com.fs.starfarer.api.campaign.FactionAPI.getPortraits

(

Gender

gender

)

getPost()

String com.fs.starfarer.api.campaign.FactionAPI.getPost

(

String

id

)

getPriorityFighters()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getPriorityFighters

(

)

getPriorityHullMods()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getPriorityHullMods

(

)

getPriorityShips()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getPriorityShips

(

)

getPriorityWeapons()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getPriorityWeapons

(

)

getProduction()

FactionProductionAPI com.fs.starfarer.api.campaign.FactionAPI.getProduction

(

)

getRank()

String com.fs.starfarer.api.campaign.FactionAPI.getRank

(

String

id

)

getRelationship()

float com.fs.starfarer.api.campaign.FactionAPI.getRelationship

(

String

id

)

getRelationshipLevel() [1/2]

RepLevel com.fs.starfarer.api.campaign.FactionAPI.getRelationshipLevel

(

FactionAPI

faction

)

getRelationshipLevel() [2/2]

RepLevel com.fs.starfarer.api.campaign.FactionAPI.getRelationshipLevel

(

String

id

)

getRelColor() [1/2]

Color com.fs.starfarer.api.campaign.FactionAPI.getRelColor

(

RepLevel

level

)

getRelColor() [2/2]

Color com.fs.starfarer.api.campaign.FactionAPI.getRelColor

(

String

otherFactionId

)

getRelToPlayer()

RelationshipAPI com.fs.starfarer.api.campaign.FactionAPI.getRelToPlayer

(

)

getRepInt()

int com.fs.starfarer.api.campaign.FactionAPI.getRepInt

(

String

id

)

getSecondaryColorOverride()

Color com.fs.starfarer.api.campaign.FactionAPI.getSecondaryColorOverride

(

)

getSecondaryColorSegmentsOverride()

int com.fs.starfarer.api.campaign.FactionAPI.getSecondaryColorSegmentsOverride

(

)

getSecondarySegments()

int com.fs.starfarer.api.campaign.FactionAPI.getSecondarySegments

(

)

getSecondaryUIColor()

Color com.fs.starfarer.api.campaign.FactionAPI.getSecondaryUIColor

(

)

getShipNamePrefix()

String com.fs.starfarer.api.campaign.FactionAPI.getShipNamePrefix

(

)

getShipNamePrefixOverride()

String com.fs.starfarer.api.campaign.FactionAPI.getShipNamePrefixOverride

(

)

getShipTimestamps()

Map< String, Long > com.fs.starfarer.api.campaign.FactionAPI.getShipTimestamps

(

)

getStockFleetIds()

List< String > com.fs.starfarer.api.campaign.FactionAPI.getStockFleetIds

(

)

getTariffFraction()

float com.fs.starfarer.api.campaign.FactionAPI.getTariffFraction

(

)

getTollFraction()

float com.fs.starfarer.api.campaign.FactionAPI.getTollFraction

(

)

getVariantOverrides()

Map< String, Float > com.fs.starfarer.api.campaign.FactionAPI.getVariantOverrides

(

)

getVariantsForRole()

Set< String > com.fs.starfarer.api.campaign.FactionAPI.getVariantsForRole

(

String

roleId

)

getVariantWeightForRole()

float com.fs.starfarer.api.campaign.FactionAPI.getVariantWeightForRole	(	String	roleId,
		ShipPickMode	mode
	)

getWeaponSellFrequency()

Map< String, Float > com.fs.starfarer.api.campaign.FactionAPI.getWeaponSellFrequency

(

)

getWeaponTimestamps()

Map< String, Long > com.fs.starfarer.api.campaign.FactionAPI.getWeaponTimestamps

(

)

initSpecIfNeeded()

void com.fs.starfarer.api.campaign.FactionAPI.initSpecIfNeeded

(

)

isAtBest() [1/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isAtBest	(	FactionAPI	other,
		RepLevel	level
	)

isAtBest() [2/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isAtBest	(	String	id,
		RepLevel	level
	)

isAtWorst() [1/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isAtWorst	(	FactionAPI	other,
		RepLevel	level
	)

isAtWorst() [2/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isAtWorst	(	String	id,
		RepLevel	level
	)

isAutoEnableKnownFighters()

boolean com.fs.starfarer.api.campaign.FactionAPI.isAutoEnableKnownFighters

(

)

isAutoEnableKnownHullmods()

boolean com.fs.starfarer.api.campaign.FactionAPI.isAutoEnableKnownHullmods

(

)

isAutoEnableKnownShips()

boolean com.fs.starfarer.api.campaign.FactionAPI.isAutoEnableKnownShips

(

)

isAutoEnableKnownWeapons()

boolean com.fs.starfarer.api.campaign.FactionAPI.isAutoEnableKnownWeapons

(

)

isFighterKnownAt()

boolean com.fs.starfarer.api.campaign.FactionAPI.isFighterKnownAt	(	String	wing,
		Long	timestamp
	)

isFighterPriority()

boolean com.fs.starfarer.api.campaign.FactionAPI.isFighterPriority

(

String

wingId

)

isHostileTo() [1/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isHostileTo

(

FactionAPI

other

)

isHostileTo() [2/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isHostileTo

(

String

other

)

isHullModPriority()

boolean com.fs.starfarer.api.campaign.FactionAPI.isHullModPriority

(

String

modId

)

isIllegal() [1/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isIllegal

(

CargoStackAPI

stack

)

isIllegal() [2/2]

boolean com.fs.starfarer.api.campaign.FactionAPI.isIllegal

(

String

commodityId

)

isNeutralFaction()

boolean com.fs.starfarer.api.campaign.FactionAPI.isNeutralFaction

(

)

isPlayerFaction()

boolean com.fs.starfarer.api.campaign.FactionAPI.isPlayerFaction

(

)

isShipKnownAt()

boolean com.fs.starfarer.api.campaign.FactionAPI.isShipKnownAt	(	String	hullId,
		Long	timestamp
	)

isShipPriority()

boolean com.fs.starfarer.api.campaign.FactionAPI.isShipPriority

(

String

hullId

)

isShowInIntelTab()

boolean com.fs.starfarer.api.campaign.FactionAPI.isShowInIntelTab

(

)

isWeaponKnownAt()

boolean com.fs.starfarer.api.campaign.FactionAPI.isWeaponKnownAt	(	String	weaponId,
		Long	timestamp
	)

isWeaponPriority()

boolean com.fs.starfarer.api.campaign.FactionAPI.isWeaponPriority

(

String

weaponId

)

knowsFighter()

boolean com.fs.starfarer.api.campaign.FactionAPI.knowsFighter

(

String

wingId

)

knowsHullMod()

boolean com.fs.starfarer.api.campaign.FactionAPI.knowsHullMod

(

String

modId

)

knowsIndustry()

boolean com.fs.starfarer.api.campaign.FactionAPI.knowsIndustry

(

String

industryId

)

knowsShip()

boolean com.fs.starfarer.api.campaign.FactionAPI.knowsShip

(

String

hullId

)

knowsWeapon()

boolean com.fs.starfarer.api.campaign.FactionAPI.knowsWeapon

(

String

weaponId

)

makeCommodityIllegal()

void com.fs.starfarer.api.campaign.FactionAPI.makeCommodityIllegal

(

String

commodityId

)

makeCommodityLegal()

void com.fs.starfarer.api.campaign.FactionAPI.makeCommodityLegal

(

String

commodityId

)

pickPersonality()

String com.fs.starfarer.api.campaign.FactionAPI.pickPersonality

(

)

pickRandomShipName() [1/2]

String com.fs.starfarer.api.campaign.FactionAPI.pickRandomShipName

(

)

pickRandomShipName() [2/2]

String com.fs.starfarer.api.campaign.FactionAPI.pickRandomShipName

(

Random

random

)

pickShip() [1/2]

List< ShipRolePick > com.fs.starfarer.api.campaign.FactionAPI.pickShip	(	String	role,
		ShipPickParams	params
	)

pickShip() [2/2]

List< ShipRolePick > com.fs.starfarer.api.campaign.FactionAPI.pickShip	(	String	role,
		ShipPickParams	params,
		ShipFilter	filter,
		Random	random
	)

pickShipAndAddToFleet() [1/2]

float com.fs.starfarer.api.campaign.FactionAPI.pickShipAndAddToFleet	(	String	role,
		ShipPickParams	params,
		CampaignFleetAPI	fleet
	)

May add more than one ship if a fallback specifies to add multiple ships. (For example, 2 small freighters if a medium freighter isn't available.)

Returns a total weight of ships added to the fleet. Generally will return 1 when ships were added, 0 when they weren't, and a number >1 when adding, say, a medium ship instead of a small one because no small ones are available.

Parameters

role
maxFP
fleet

Returns

pickShipAndAddToFleet() [2/2]

float com.fs.starfarer.api.campaign.FactionAPI.pickShipAndAddToFleet	(	String	role,
		ShipPickParams	params,
		CampaignFleetAPI	fleet,
		Random	random
	)

pickVoice()

String com.fs.starfarer.api.campaign.FactionAPI.pickVoice	(	PersonImportance	importance,
		Random	random
	)

removeKnownFighter()

void com.fs.starfarer.api.campaign.FactionAPI.removeKnownFighter

(

String

wingId

)

All of the blueprints specified in the .faction file are re-added to the faction every time a savegame is loaded. To make blueprint removal permanent, the list of things-to-remove needs to be stored and they need to be re-removed on every game load.

removeKnownHullMod()

void com.fs.starfarer.api.campaign.FactionAPI.removeKnownHullMod

(

String

modId

)

removeKnownIndustry()

void com.fs.starfarer.api.campaign.FactionAPI.removeKnownIndustry

(

String

industryId

)

removeKnownShip()

void com.fs.starfarer.api.campaign.FactionAPI.removeKnownShip

(

String

hullId

)

All of the blueprints specified in the .faction file are re-added to the faction every time a savegame is loaded. To make blueprint removal permanent, the list of things-to-remove needs to be stored and they need to be re-removed on every game load.

removeKnownWeapon()

void com.fs.starfarer.api.campaign.FactionAPI.removeKnownWeapon

(

String

weaponId

)

All of the blueprints specified in the .faction file are re-added to the faction every time a savegame is loaded. To make blueprint removal permanent, the list of things-to-remove needs to be stored and they need to be re-removed on every game load.

removePriorityFighter()

void com.fs.starfarer.api.campaign.FactionAPI.removePriorityFighter

(

String

wingId

)

removePriorityHullMod()

void com.fs.starfarer.api.campaign.FactionAPI.removePriorityHullMod

(

String

modId

)

removePriorityShip()

void com.fs.starfarer.api.campaign.FactionAPI.removePriorityShip

(

String

hullId

)

removePriorityWeapon()

void com.fs.starfarer.api.campaign.FactionAPI.removePriorityWeapon

(

String

weaponId

)

removeUseWhenImportingShip()

void com.fs.starfarer.api.campaign.FactionAPI.removeUseWhenImportingShip

(

String

hullId

)

setAutoEnableKnownFighters()

void com.fs.starfarer.api.campaign.FactionAPI.setAutoEnableKnownFighters

(

boolean

autoEnableKnownFighters

)

setAutoEnableKnownHullmods()

void com.fs.starfarer.api.campaign.FactionAPI.setAutoEnableKnownHullmods

(

boolean

autoEnableKnownHullmods

)

setAutoEnableKnownShips()

void com.fs.starfarer.api.campaign.FactionAPI.setAutoEnableKnownShips

(

boolean

autoEnableKnownShips

)

setAutoEnableKnownWeapons()

void com.fs.starfarer.api.campaign.FactionAPI.setAutoEnableKnownWeapons

(

boolean

autoEnableKnownWeapons

)

setDisplayIsOrAreOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setDisplayIsOrAreOverride

(

String

displayIsOrAreOverride

)

setDisplayNameOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setDisplayNameOverride

(

String

displayNameOverride

)

setDisplayNameWithArticleOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setDisplayNameWithArticleOverride

(

String

displayNameWithArticleOverride

)

setFactionCrestOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setFactionCrestOverride

(

String

factionCrestOverride

)

setFactionLogoOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setFactionLogoOverride

(

String

factionLogoOverride

)

setFighterTimestampToNow()

void com.fs.starfarer.api.campaign.FactionAPI.setFighterTimestampToNow

(

String

wingId

)

setPersonNamePrefixAOrAnOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setPersonNamePrefixAOrAnOverride

(

String

personNamePrefixAOrAnOverride

)

setRelationship() [1/2]

void com.fs.starfarer.api.campaign.FactionAPI.setRelationship	(	String	id,
		float	newValue
	)

setRelationship() [2/2]

void com.fs.starfarer.api.campaign.FactionAPI.setRelationship	(	String	id,
		RepLevel	level
	)

setSecondaryColorOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setSecondaryColorOverride

(

Color

secondaryOverride

)

setSecondaryColorSegmentsOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setSecondaryColorSegmentsOverride

(

int

secondaryColorSegmentsOverride

)

setShipNamePrefixOverride()

void com.fs.starfarer.api.campaign.FactionAPI.setShipNamePrefixOverride

(

String

shipNamePrefixOverride

)

setShipTimestampToNow()

void com.fs.starfarer.api.campaign.FactionAPI.setShipTimestampToNow

(

String

hullId

)

setShowInIntelTab()

void com.fs.starfarer.api.campaign.FactionAPI.setShowInIntelTab

(

boolean

isShowInIntelTab

)

setWeaponTimestampToNow()

void com.fs.starfarer.api.campaign.FactionAPI.setWeaponTimestampToNow

(

String

weaponId

)

useWhenImportingShip()

boolean com.fs.starfarer.api.campaign.FactionAPI.useWhenImportingShip

(

String

hullId

)

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/campaign/FactionAPI.java