com.fs.starfarer.api.campaign

Interface SectorAPI

public interface SectorAPI

Note: generics can not be used in scripts. They are used in this API purely to show the return/parameter types of functions more clearly.

Method Summary

Modifier and Type	Method and Description
void	addListener(CampaignEventListener listener)
void	addListenerWithTimeout(CampaignEventListener listener, float daysToKeep)
EveryFrameScript	addPing(SectorEntityToken entity, CampaignPingSpec custom)
EveryFrameScript	addPing(SectorEntityToken entity, java.lang.String pingType) See data/campaign/pings.json for ping types.
EveryFrameScript	addPing(SectorEntityToken entity, java.lang.String pingType, java.awt.Color colorOverride)
void	addScript(EveryFrameScript script)
void	addTransientListener(CampaignEventListener listener)
void	addTransientScript(EveryFrameScript script)
ReputationActionResponsePlugin.ReputationAdjustmentResult	adjustPlayerReputation(java.lang.Object action, PersonAPI person) Adjust the player's reputation with the specified person, based on the action.
ReputationActionResponsePlugin.ReputationAdjustmentResult	adjustPlayerReputation(java.lang.Object action, java.lang.String factionId) Adjust the player's reputation with the specified faction, based on the action.
NascentGravityWellAPI	createNascentGravityWell(SectorEntityToken target, float radius)
StarSystemAPI	createStarSystem(java.lang.String name)
void	doHyperspaceTransition(CampaignFleetAPI fleet, SectorEntityToken jumpLocation, JumpPointAPI.JumpDestination dest)
void	doHyperspaceTransition(CampaignFleetAPI fleetAPI, SectorEntityToken jumpLocation, JumpPointAPI.JumpDestination dest, float initialDelay)
java.lang.String	genUID()
java.util.List<java.lang.String>	getAllEmptyVariantIds()
java.util.List<FactionAPI>	getAllFactions()
java.util.List<java.lang.String>	getAllFighterWingIds()
java.util.List<CampaignEventListener>	getAllListeners()
java.util.List<LocationAPI>	getAllLocations() All star systems and hyperspace.
java.util.List<java.lang.String>	getAllWeaponIds()
AutofitVariantsAPI	getAutofitVariants()
CampaignUIAPI	getCampaignUI()
CharacterDataAPI	getCharacterData()
CampaignClockAPI	getClock()
LocationAPI	getCurrentLocation()
MarketAPI	getCurrentlyOpenMarket()
java.util.List<SectorEntityToken>	getCustomEntitiesWithTag(java.lang.String tag)
java.lang.String	getDifficulty()
EconomyAPI	getEconomy()
java.util.List<SectorEntityToken>	getEntitiesWithTag(java.lang.String tag) Iterates through hyperspace and all star systems.
SectorEntityToken	getEntityById(java.lang.String id) Will look for the entity in all LocationAPIs.
CampaignEventManagerAPI	getEventManager()
FactionAPI	getFaction(java.lang.String factionId)
GenericPluginManagerAPI	getGenericPlugins()
LocationAPI	getHyperspace()
ImportantPeopleAPI	getImportantPeople()
IntelDataAPI	getIntel()
IntelManagerAPI	getIntelManager()
long	getLastPlayerBattleTimestamp()
ListenerManagerAPI	getListenerManager()
MemoryAPI	getMemory() "global" memory.
MemoryAPI	getMemoryWithoutUpdate()
SectorEntityToken	getMousedOverEntity()
java.util.Map<java.lang.String,java.lang.Object>	getPersistentData() Can be used (including by classes that are not part of the savegame - i.e.
long	getPlayerBattleSeed()
FactionAPI	getPlayerFaction()
CampaignFleetAPI	getPlayerFleet()
MemoryAPI	getPlayerMemoryWithoutUpdate() Same as getCharacterData().getMemoryWithoutUpdate()
PersonAPI	getPlayerPerson()
MutableCharacterStatsAPI	getPlayerStats()
PluginPickerAPI	getPluginPicker()
org.lwjgl.util.vector.Vector2f	getRespawnCoordinates()
LocationAPI	getRespawnLocation()
RulesAPI	getRules()
java.util.List<EveryFrameScript>	getScripts()
java.lang.String	getSeedString()
StarSystemAPI	getStarSystem(java.lang.String name)
java.util.List<StarSystemAPI>	getStarSystems()
java.util.List<EveryFrameScript>	getTransientScripts()
PersistentUIDataAPI	getUIData()
ViewportAPI	getViewport()
boolean	hasScript(java.lang.Class<?> clazz)
boolean	hasTransientScript(java.lang.Class<?> clazz)
boolean	isFastForwardIteration()
boolean	isInFastAdvance() true during the during-game-creation time passing.
boolean	isInNewGameAdvance()
boolean	isInSectorGen()
boolean	isIronMode()
boolean	isLastPlayerBattleWon()
boolean	isPaused()
void	layInCourseFor(SectorEntityToken target)
void	registerPlugin(CampaignPlugin plugin)
void	removeListener(CampaignEventListener listener)
void	removeScript(EveryFrameScript script)
void	removeScriptsOfClass(java.lang.Class c)
void	removeStarSystem(StarSystemAPI system)
void	removeStarSystemNextFrame(StarSystemAPI system) Useful for remove star systems from scripts etc where using removeStarSystem() would cause a ConcurrentModificationException.
void	removeTransientScript(EveryFrameScript script)
void	removeTransientScriptsOfClass(java.lang.Class c)
void	reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle) Called after an autoresolve round that finishes a battle, after reportBattleOccurred.
void	reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle) Called once per each autoresolve round of the battle.
void	reportEconomyMonthEnd()
void	reportEconomyTick(int iterIndex)
void	reportEncounterLootGenerated(FleetEncounterContextPlugin plugin, CargoAPI loot)
void	reportEventStage(CampaignEventPlugin event, java.lang.String stage, MessagePriority priority) Deprecated.
void	reportEventStage(CampaignEventPlugin event, java.lang.String stage, SectorEntityToken sendFrom, MessagePriority priority) Deprecated.
void	reportEventStage(CampaignEventPlugin event, java.lang.String stage, SectorEntityToken sendFrom, MessagePriority priority, OnMessageDeliveryScript onDelivery) Deprecated.
void	reportFleetDespawned(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
void	reportFleetJumped(CampaignFleetAPI fleet, SectorEntityToken from, JumpPointAPI.JumpDestination to)
void	reportFleetReachedEntity(CampaignFleetAPI fleet, SectorEntityToken entity)
void	reportPlayerActivatedAbility(AbilityPlugin ability, java.lang.Object param)
void	reportPlayerClosedMarket(MarketAPI market)
void	reportPlayerDeactivatedAbility(AbilityPlugin ability, java.lang.Object param)
void	reportPlayerDidNotTakeCargo(CargoAPI cargo)
void	reportPlayerDumpedCargo(CargoAPI cargo)
void	reportPlayerEngagement(EngagementResultAPI result)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	reportPlayerOpenedMarket(MarketAPI market) Player opened the core UI while interacting with an entity that has a market.
void	reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)
void	reportPlayerReputationChange(PersonAPI person, float delta)
void	reportPlayerReputationChange(java.lang.String faction, float delta)
void	reportShowInteractionDialog(InteractionDialogAPI dialog) Shouldn't have to call this as the relevant showInteractionDialog() methods already do.
void	setCurrentLocation(LocationAPI location)
void	setCurrentlyOpenMarket(MarketAPI currentlyOpenMarket)
void	setDifficulty(java.lang.String difficulty)
void	setFastForwardIteration(boolean isFastForwardIteration)
void	setInFastAdvance(boolean isInNewGameAdvance)
void	setInNewGameAdvance(boolean isInNewGameAdvance)
void	setInSectorGen(boolean isInSectorGen)
void	setLastPlayerBattleTimestamp(long lastPlayerBattleTimestamp)
void	setLastPlayerBattleWon(boolean lastPlayerBattleWon)
void	setPaused(boolean paused)
void	setPlayerBattleSeed(long nextPlayerBattleSeed)
void	setPlayerFleet(CampaignFleetAPI playerFleet)
void	setRespawnLocation(LocationAPI respawnLocation)
void	setSeedString(java.lang.String seedString)
void	unregisterPlugin(java.lang.String pluginId)

Method Detail

getPersistentData

java.util.Map<java.lang.String,java.lang.Object> getPersistentData()

Can be used (including by classes that are not part of the savegame - i.e. ModPlugin or transient CampaignPlugin implementations) to save data between sessions.

Returns:

registerPlugin

void registerPlugin(CampaignPlugin plugin)

unregisterPlugin

void unregisterPlugin(java.lang.String pluginId)

getStarSystem

StarSystemAPI getStarSystem(java.lang.String name)

createStarSystem

StarSystemAPI createStarSystem(java.lang.String name)

getStarSystems

java.util.List<StarSystemAPI> getStarSystems()

removeStarSystem

void removeStarSystem(StarSystemAPI system)

setCurrentLocation

void setCurrentLocation(LocationAPI location)

getHyperspace

LocationAPI getHyperspace()

doHyperspaceTransition

void doHyperspaceTransition(CampaignFleetAPI fleet,
                            SectorEntityToken jumpLocation,
                            JumpPointAPI.JumpDestination dest)

Parameters:

fleet -

jumpLocation - can be null. If not, fleet will attempt to reach it before jumping. Failure will result in aborted jump.

dest -

getClock

CampaignClockAPI getClock()

getPlayerFleet

CampaignFleetAPI getPlayerFleet()

getFaction

FactionAPI getFaction(java.lang.String factionId)

getAllFactions

java.util.List<FactionAPI> getAllFactions()

getAllWeaponIds

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

getAllEmptyVariantIds

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

getAllFighterWingIds

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

getCampaignUI

CampaignUIAPI getCampaignUI()

getEventManager

CampaignEventManagerAPI getEventManager()

setPaused

void setPaused(boolean paused)

isPaused

boolean isPaused()

addScript

void addScript(EveryFrameScript script)

removeScriptsOfClass

void removeScriptsOfClass(java.lang.Class c)

removeScript

void removeScript(EveryFrameScript script)

addTransientScript

void addTransientScript(EveryFrameScript script)

removeTransientScript

void removeTransientScript(EveryFrameScript script)

getCurrentLocation

LocationAPI getCurrentLocation()

getRespawnLocation

LocationAPI getRespawnLocation()

setRespawnLocation

void setRespawnLocation(LocationAPI respawnLocation)

getRespawnCoordinates

org.lwjgl.util.vector.Vector2f getRespawnCoordinates()

getCharacterData

CharacterDataAPI getCharacterData()

reportEventStage

@Deprecated
void reportEventStage(CampaignEventPlugin event,
                                  java.lang.String stage,
                                  MessagePriority priority)

Deprecated.

Does nothing. Replaced with getIntelManager().

reportEventStage

@Deprecated
void reportEventStage(CampaignEventPlugin event,
                                  java.lang.String stage,
                                  SectorEntityToken sendFrom,
                                  MessagePriority priority)

Deprecated.

Does nothing. Replaced with getIntelManager().

reportEventStage

@Deprecated
void reportEventStage(CampaignEventPlugin event,
                                  java.lang.String stage,
                                  SectorEntityToken sendFrom,
                                  MessagePriority priority,
                                  OnMessageDeliveryScript onDelivery)

Deprecated.

Does nothing. Replaced with getIntelManager().

getRules

RulesAPI getRules()

getLastPlayerBattleTimestamp

long getLastPlayerBattleTimestamp()

isLastPlayerBattleWon

boolean isLastPlayerBattleWon()

getMemory

MemoryAPI getMemory()

"global" memory.

Returns:

getMemoryWithoutUpdate

MemoryAPI getMemoryWithoutUpdate()

getIntel

IntelDataAPI getIntel()

getEntityById

SectorEntityToken getEntityById(java.lang.String id)

Will look for the entity in all LocationAPIs.

Parameters:

id -

Returns:

getEntitiesWithTag

java.util.List<SectorEntityToken> getEntitiesWithTag(java.lang.String tag)

Iterates through hyperspace and all star systems.

Parameters:

tag -

Returns:

getEconomy

EconomyAPI getEconomy()

addListener

void addListener(CampaignEventListener listener)

addTransientListener

void addTransientListener(CampaignEventListener listener)

addListenerWithTimeout

void addListenerWithTimeout(CampaignEventListener listener,
                            float daysToKeep)

removeListener

void removeListener(CampaignEventListener listener)

getAllListeners

java.util.List<CampaignEventListener> getAllListeners()

reportPlayerMarketTransaction

void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

reportFleetDespawned

void reportFleetDespawned(CampaignFleetAPI fleet,
                          CampaignEventListener.FleetDespawnReason reason,
                          java.lang.Object param)

reportFleetJumped

void reportFleetJumped(CampaignFleetAPI fleet,
                       SectorEntityToken from,
                       JumpPointAPI.JumpDestination to)

reportFleetReachedEntity

void reportFleetReachedEntity(CampaignFleetAPI fleet,
                              SectorEntityToken entity)

reportBattleOccurred

void reportBattleOccurred(CampaignFleetAPI primaryWinner,
                          BattleAPI battle)

Called once per each autoresolve round of the battle. Also called after a player battle occurred. Fleets and their compositons snapshotted right before the autoresolve round.

Parameters:

battle -

primaryWinner -

reportBattleFinished

void reportBattleFinished(CampaignFleetAPI primaryWinner,
                          BattleAPI battle)

Called after an autoresolve round that finishes a battle, after reportBattleOccurred. Also called after a player battle occurred. Fleets and their compositons snapshotted right before the autoresolve round.

Parameters:

battle -

primaryWinner -

adjustPlayerReputation

ReputationActionResponsePlugin.ReputationAdjustmentResult adjustPlayerReputation(java.lang.Object action,
                                                                                 java.lang.String factionId)

Adjust the player's reputation with the specified faction, based on the action. This method will pick the highest-priority ReputationActionResponsePlugin and call its handlePlayerReputationAction() method with these parameters. See CoreCampaignPluginImpl.handlePlayerReputationAction() for an implementation example.

Parameters:

action -

faction -

Returns:

adjustPlayerReputation

ReputationActionResponsePlugin.ReputationAdjustmentResult adjustPlayerReputation(java.lang.Object action,
                                                                                 PersonAPI person)

Adjust the player's reputation with the specified person, based on the action. This method will pick the highest-priority ReputationActionResponsePlugin and call its handlePlayerReputationAction() method with these parameters. See CoreCampaignPluginImpl.handlePlayerReputationAction() for an implementation example.

Parameters:

action -

person -

Returns:

addPing

EveryFrameScript addPing(SectorEntityToken entity,
                         java.lang.String pingType)

See data/campaign/pings.json for ping types.

Parameters:

entity -

pingType -

reportShowInteractionDialog

void reportShowInteractionDialog(InteractionDialogAPI dialog)

Shouldn't have to call this as the relevant showInteractionDialog() methods already do.

Parameters:

dialog -

reportPlayerOpenedMarket

void reportPlayerOpenedMarket(MarketAPI market)

Player opened the core UI while interacting with an entity that has a market.

Parameters:

market -

reportPlayerReputationChange

void reportPlayerReputationChange(java.lang.String faction,
                                  float delta)

reportPlayerReputationChange

void reportPlayerReputationChange(PersonAPI person,
                                  float delta)

reportPlayerEngagement

void reportPlayerEngagement(EngagementResultAPI result)

isInFastAdvance

boolean isInFastAdvance()

true during the during-game-creation time passing.

Returns:

getPlayerPerson

PersonAPI getPlayerPerson()

reportPlayerOpenedMarketAndCargoUpdated

void reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)

reportEncounterLootGenerated

void reportEncounterLootGenerated(FleetEncounterContextPlugin plugin,
                                  CargoAPI loot)

reportPlayerClosedMarket

void reportPlayerClosedMarket(MarketAPI market)

reportPlayerActivatedAbility

void reportPlayerActivatedAbility(AbilityPlugin ability,
                                  java.lang.Object param)

reportPlayerDeactivatedAbility

void reportPlayerDeactivatedAbility(AbilityPlugin ability,
                                    java.lang.Object param)

reportPlayerDumpedCargo

void reportPlayerDumpedCargo(CargoAPI cargo)

getImportantPeople

ImportantPeopleAPI getImportantPeople()

getPlayerFaction

FactionAPI getPlayerFaction()

addPing

EveryFrameScript addPing(SectorEntityToken entity,
                         java.lang.String pingType,
                         java.awt.Color colorOverride)

getViewport

ViewportAPI getViewport()

getAllLocations

java.util.List<LocationAPI> getAllLocations()

All star systems and hyperspace.

Returns:

getDifficulty

java.lang.String getDifficulty()

setDifficulty

void setDifficulty(java.lang.String difficulty)

isIronMode

boolean isIronMode()

hasScript

boolean hasScript(java.lang.Class<?> clazz)

getPluginPicker

PluginPickerAPI getPluginPicker()

getSeedString

java.lang.String getSeedString()

setSeedString

void setSeedString(java.lang.String seedString)

genUID

java.lang.String genUID()

getUIData

PersistentUIDataAPI getUIData()

setInFastAdvance

void setInFastAdvance(boolean isInNewGameAdvance)

isInNewGameAdvance

boolean isInNewGameAdvance()

setInNewGameAdvance

void setInNewGameAdvance(boolean isInNewGameAdvance)

setPlayerFleet

void setPlayerFleet(CampaignFleetAPI playerFleet)

setLastPlayerBattleTimestamp

void setLastPlayerBattleTimestamp(long lastPlayerBattleTimestamp)

setLastPlayerBattleWon

void setLastPlayerBattleWon(boolean lastPlayerBattleWon)

reportPlayerDidNotTakeCargo

void reportPlayerDidNotTakeCargo(CargoAPI cargo)

getScripts

java.util.List<EveryFrameScript> getScripts()

getTransientScripts

java.util.List<EveryFrameScript> getTransientScripts()

getGenericPlugins

GenericPluginManagerAPI getGenericPlugins()

addPing

EveryFrameScript addPing(SectorEntityToken entity,
                         CampaignPingSpec custom)

reportEconomyMonthEnd

void reportEconomyMonthEnd()

reportEconomyTick

void reportEconomyTick(int iterIndex)

getPlayerStats

MutableCharacterStatsAPI getPlayerStats()

getAutofitVariants

AutofitVariantsAPI getAutofitVariants()

getIntelManager

IntelManagerAPI getIntelManager()

getListenerManager

ListenerManagerAPI getListenerManager()

removeTransientScriptsOfClass

void removeTransientScriptsOfClass(java.lang.Class c)

getPlayerBattleSeed

long getPlayerBattleSeed()

setPlayerBattleSeed

void setPlayerBattleSeed(long nextPlayerBattleSeed)

createNascentGravityWell

NascentGravityWellAPI createNascentGravityWell(SectorEntityToken target,
                                               float radius)

hasTransientScript

boolean hasTransientScript(java.lang.Class<?> clazz)

getCustomEntitiesWithTag

java.util.List<SectorEntityToken> getCustomEntitiesWithTag(java.lang.String tag)

doHyperspaceTransition

void doHyperspaceTransition(CampaignFleetAPI fleetAPI,
                            SectorEntityToken jumpLocation,
                            JumpPointAPI.JumpDestination dest,
                            float initialDelay)

layInCourseFor

void layInCourseFor(SectorEntityToken target)

isFastForwardIteration

boolean isFastForwardIteration()

setFastForwardIteration

void setFastForwardIteration(boolean isFastForwardIteration)

getPlayerMemoryWithoutUpdate

MemoryAPI getPlayerMemoryWithoutUpdate()

Same as getCharacterData().getMemoryWithoutUpdate()

Returns:

removeStarSystemNextFrame

void removeStarSystemNextFrame(StarSystemAPI system)

Useful for remove star systems from scripts etc where using removeStarSystem() would cause a ConcurrentModificationException.

Parameters:

system -

getMousedOverEntity

SectorEntityToken getMousedOverEntity()

getCurrentlyOpenMarket

MarketAPI getCurrentlyOpenMarket()

setCurrentlyOpenMarket

void setCurrentlyOpenMarket(MarketAPI currentlyOpenMarket)

isInSectorGen

boolean isInSectorGen()

setInSectorGen

void setInSectorGen(boolean isInSectorGen)