Public Member Functions
Map< String, Object >	getPersistentData ()

void	registerPlugin (CampaignPlugin plugin)

void	unregisterPlugin (String pluginId)

StarSystemAPI	getStarSystem (String name)

StarSystemAPI	createStarSystem (String name)

List< StarSystemAPI >	getStarSystems ()

void	removeStarSystem (StarSystemAPI system)

void	setCurrentLocation (LocationAPI location)

LocationAPI	getHyperspace ()

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

CampaignClockAPI	getClock ()

CampaignFleetAPI	getPlayerFleet ()

FactionAPI	getFaction (String factionId)

List< FactionAPI >	getAllFactions ()

List< String >	getAllWeaponIds ()

List< String >	getAllEmptyVariantIds ()

List< String >	getAllFighterWingIds ()

CampaignUIAPI	getCampaignUI ()

CampaignEventManagerAPI	getEventManager ()

void	setPaused (boolean paused)

boolean	isPaused ()

void	addScript (EveryFrameScript script)

void	removeScriptsOfClass (Class c)

void	removeScript (EveryFrameScript script)

void	addTransientScript (EveryFrameScript script)

void	removeTransientScript (EveryFrameScript script)

LocationAPI	getCurrentLocation ()

LocationAPI	getRespawnLocation ()

void	setRespawnLocation (LocationAPI respawnLocation)

Vector2f	getRespawnCoordinates ()

CharacterDataAPI	getCharacterData ()

void	reportEventStage (CampaignEventPlugin event, String stage, MessagePriority priority)

void	reportEventStage (CampaignEventPlugin event, String stage, SectorEntityToken sendFrom, MessagePriority priority)

void	reportEventStage (CampaignEventPlugin event, String stage, SectorEntityToken sendFrom, MessagePriority priority, OnMessageDeliveryScript onDelivery)

RulesAPI	getRules ()

long	getLastPlayerBattleTimestamp ()

boolean	isLastPlayerBattleWon ()

MemoryAPI	getMemory ()

MemoryAPI	getMemoryWithoutUpdate ()

IntelDataAPI	getIntel ()

SectorEntityToken	getEntityById (String id)

List< SectorEntityToken >	getEntitiesWithTag (String tag)

EconomyAPI	getEconomy ()

void	addListener (CampaignEventListener listener)

void	addTransientListener (CampaignEventListener listener)

void	addListenerWithTimeout (CampaignEventListener listener, float daysToKeep)

void	removeListener (CampaignEventListener listener)

List< CampaignEventListener >	getAllListeners ()

void	reportPlayerMarketTransaction (PlayerMarketTransaction transaction)

void	reportFleetDespawned (CampaignFleetAPI fleet, FleetDespawnReason reason, Object param)

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

void	reportFleetReachedEntity (CampaignFleetAPI fleet, SectorEntityToken entity)

void	reportBattleOccurred (CampaignFleetAPI primaryWinner, BattleAPI battle)

void	reportBattleFinished (CampaignFleetAPI primaryWinner, BattleAPI battle)

ReputationAdjustmentResult	adjustPlayerReputation (Object action, String factionId)

ReputationAdjustmentResult	adjustPlayerReputation (Object action, PersonAPI person)

EveryFrameScript	addPing (SectorEntityToken entity, String pingType)

void	reportShowInteractionDialog (InteractionDialogAPI dialog)

void	reportPlayerOpenedMarket (MarketAPI market)

void	reportPlayerReputationChange (String faction, float delta)

void	reportPlayerReputationChange (PersonAPI person, float delta)

void	reportPlayerEngagement (EngagementResultAPI result)

boolean	isInFastAdvance ()

PersonAPI	getPlayerPerson ()

void	reportPlayerOpenedMarketAndCargoUpdated (MarketAPI market)

void	reportEncounterLootGenerated (FleetEncounterContextPlugin plugin, CargoAPI loot)

void	reportPlayerClosedMarket (MarketAPI market)

void	reportPlayerActivatedAbility (AbilityPlugin ability, Object param)

void	reportPlayerDeactivatedAbility (AbilityPlugin ability, Object param)

void	reportPlayerDumpedCargo (CargoAPI cargo)

ImportantPeopleAPI	getImportantPeople ()

FactionAPI	getPlayerFaction ()

EveryFrameScript	addPing (SectorEntityToken entity, String pingType, Color colorOverride)

ViewportAPI	getViewport ()

List< LocationAPI >	getAllLocations ()

String	getDifficulty ()

void	setDifficulty (String difficulty)

boolean	isIronMode ()

boolean	hasScript (Class<?> clazz)

PluginPickerAPI	getPluginPicker ()

String	getSeedString ()

void	setSeedString (String seedString)

String	genUID ()

PersistentUIDataAPI	getUIData ()

void	setInFastAdvance (boolean isInNewGameAdvance)

boolean	isInNewGameAdvance ()

void	setInNewGameAdvance (boolean isInNewGameAdvance)

void	setPlayerFleet (CampaignFleetAPI playerFleet)

void	setLastPlayerBattleTimestamp (long lastPlayerBattleTimestamp)

void	setLastPlayerBattleWon (boolean lastPlayerBattleWon)

void	reportPlayerDidNotTakeCargo (CargoAPI cargo)

List< EveryFrameScript >	getScripts ()

List< EveryFrameScript >	getTransientScripts ()

GenericPluginManagerAPI	getGenericPlugins ()

EveryFrameScript	addPing (SectorEntityToken entity, CampaignPingSpec custom)

void	reportEconomyMonthEnd ()

void	reportEconomyTick (int iterIndex)

MutableCharacterStatsAPI	getPlayerStats ()

AutofitVariantsAPI	getAutofitVariants ()

IntelManagerAPI	getIntelManager ()

ListenerManagerAPI	getListenerManager ()

void	removeTransientScriptsOfClass (Class c)

long	getPlayerBattleSeed ()

void	setPlayerBattleSeed (long nextPlayerBattleSeed)

NascentGravityWellAPI	createNascentGravityWell (SectorEntityToken target, float radius)

boolean	hasTransientScript (Class<?> clazz)

List< SectorEntityToken >	getCustomEntitiesWithTag (String tag)

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

void	layInCourseFor (SectorEntityToken target)

boolean	isFastForwardIteration ()

void	setFastForwardIteration (boolean isFastForwardIteration)

MemoryAPI	getPlayerMemoryWithoutUpdate ()

void	removeStarSystemNextFrame (StarSystemAPI system)

SectorEntityToken	getMousedOverEntity ()

Detailed Description

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.

Author: Alex Mosolov

Definition at line 39 of file SectorAPI.java.

Member Function Documentation

◆ addListener()

void com.fs.starfarer.api.campaign.SectorAPI.addListener ( CampaignEventListener listener )

◆ addListenerWithTimeout()

void com.fs.starfarer.api.campaign.SectorAPI.addListenerWithTimeout	(	CampaignEventListener	listener,
		float	daysToKeep
	)

◆ addPing() [1/3]

EveryFrameScript com.fs.starfarer.api.campaign.SectorAPI.addPing	(	SectorEntityToken	entity,
		CampaignPingSpec	custom
	)

◆ addPing() [2/3]

EveryFrameScript com.fs.starfarer.api.campaign.SectorAPI.addPing	(	SectorEntityToken	entity,
		String	pingType
	)

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

Parameters

entity
pingType

◆ addPing() [3/3]

EveryFrameScript com.fs.starfarer.api.campaign.SectorAPI.addPing	(	SectorEntityToken	entity,
		String	pingType,
		Color	colorOverride
	)

◆ addScript()

void com.fs.starfarer.api.campaign.SectorAPI.addScript ( EveryFrameScript script )

◆ addTransientListener()

void com.fs.starfarer.api.campaign.SectorAPI.addTransientListener ( CampaignEventListener listener )

◆ addTransientScript()

void com.fs.starfarer.api.campaign.SectorAPI.addTransientScript ( EveryFrameScript script )

◆ adjustPlayerReputation() [1/2]

ReputationAdjustmentResult com.fs.starfarer.api.campaign.SectorAPI.adjustPlayerReputation	(	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

◆ adjustPlayerReputation() [2/2]

ReputationAdjustmentResult com.fs.starfarer.api.campaign.SectorAPI.adjustPlayerReputation	(	Object	action,
		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

◆ createNascentGravityWell()

NascentGravityWellAPI com.fs.starfarer.api.campaign.SectorAPI.createNascentGravityWell	(	SectorEntityToken	target,
		float	radius
	)

◆ createStarSystem()

StarSystemAPI com.fs.starfarer.api.campaign.SectorAPI.createStarSystem ( String name )

◆ doHyperspaceTransition() [1/2]

void com.fs.starfarer.api.campaign.SectorAPI.doHyperspaceTransition	(	CampaignFleetAPI	fleet,
		SectorEntityToken	jumpLocation,
		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

◆ doHyperspaceTransition() [2/2]

void com.fs.starfarer.api.campaign.SectorAPI.doHyperspaceTransition	(	CampaignFleetAPI	fleetAPI,
		SectorEntityToken	jumpLocation,
		JumpDestination	dest,
		float	initialDelay
	)

◆ genUID()

String com.fs.starfarer.api.campaign.SectorAPI.genUID ( )

◆ getAllEmptyVariantIds()

List< String > com.fs.starfarer.api.campaign.SectorAPI.getAllEmptyVariantIds ( )

◆ getAllFactions()

List< FactionAPI > com.fs.starfarer.api.campaign.SectorAPI.getAllFactions ( )

◆ getAllFighterWingIds()

List< String > com.fs.starfarer.api.campaign.SectorAPI.getAllFighterWingIds ( )

◆ getAllListeners()

List< CampaignEventListener > com.fs.starfarer.api.campaign.SectorAPI.getAllListeners ( )

◆ getAllLocations()

List< LocationAPI > com.fs.starfarer.api.campaign.SectorAPI.getAllLocations ( )

All star systems and hyperspace.

Returns

◆ getAllWeaponIds()

List< String > com.fs.starfarer.api.campaign.SectorAPI.getAllWeaponIds ( )

◆ getAutofitVariants()

AutofitVariantsAPI com.fs.starfarer.api.campaign.SectorAPI.getAutofitVariants ( )

◆ getCampaignUI()

CampaignUIAPI com.fs.starfarer.api.campaign.SectorAPI.getCampaignUI ( )

◆ getCharacterData()

CharacterDataAPI com.fs.starfarer.api.campaign.SectorAPI.getCharacterData ( )

◆ getClock()

CampaignClockAPI com.fs.starfarer.api.campaign.SectorAPI.getClock ( )

◆ getCurrentLocation()

LocationAPI com.fs.starfarer.api.campaign.SectorAPI.getCurrentLocation ( )

◆ getCustomEntitiesWithTag()

List< SectorEntityToken > com.fs.starfarer.api.campaign.SectorAPI.getCustomEntitiesWithTag ( String tag )

◆ getDifficulty()

String com.fs.starfarer.api.campaign.SectorAPI.getDifficulty ( )

◆ getEconomy()

EconomyAPI com.fs.starfarer.api.campaign.SectorAPI.getEconomy ( )

◆ getEntitiesWithTag()

List< SectorEntityToken > com.fs.starfarer.api.campaign.SectorAPI.getEntitiesWithTag ( String tag )

Iterates through hyperspace and all star systems.

Parameters

tag

Returns

◆ getEntityById()

SectorEntityToken com.fs.starfarer.api.campaign.SectorAPI.getEntityById ( String id )

Will look for the entity in all LocationAPIs.

Parameters

id

Returns

◆ getEventManager()

CampaignEventManagerAPI com.fs.starfarer.api.campaign.SectorAPI.getEventManager ( )

◆ getFaction()

FactionAPI com.fs.starfarer.api.campaign.SectorAPI.getFaction ( String factionId )

◆ getGenericPlugins()

GenericPluginManagerAPI com.fs.starfarer.api.campaign.SectorAPI.getGenericPlugins ( )

◆ getHyperspace()

LocationAPI com.fs.starfarer.api.campaign.SectorAPI.getHyperspace ( )

◆ getImportantPeople()

ImportantPeopleAPI com.fs.starfarer.api.campaign.SectorAPI.getImportantPeople ( )

◆ getIntel()

IntelDataAPI com.fs.starfarer.api.campaign.SectorAPI.getIntel ( )

◆ getIntelManager()

IntelManagerAPI com.fs.starfarer.api.campaign.SectorAPI.getIntelManager ( )

◆ getLastPlayerBattleTimestamp()

long com.fs.starfarer.api.campaign.SectorAPI.getLastPlayerBattleTimestamp ( )

◆ getListenerManager()

ListenerManagerAPI com.fs.starfarer.api.campaign.SectorAPI.getListenerManager ( )

◆ getMemory()

MemoryAPI com.fs.starfarer.api.campaign.SectorAPI.getMemory ( )

"global" memory.

Returns

◆ getMemoryWithoutUpdate()

MemoryAPI com.fs.starfarer.api.campaign.SectorAPI.getMemoryWithoutUpdate ( )

◆ getMousedOverEntity()

SectorEntityToken com.fs.starfarer.api.campaign.SectorAPI.getMousedOverEntity ( )

◆ getPersistentData()

Map< String, Object > com.fs.starfarer.api.campaign.SectorAPI.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

◆ getPlayerBattleSeed()

long com.fs.starfarer.api.campaign.SectorAPI.getPlayerBattleSeed ( )

◆ getPlayerFaction()

FactionAPI com.fs.starfarer.api.campaign.SectorAPI.getPlayerFaction ( )

◆ getPlayerFleet()

CampaignFleetAPI com.fs.starfarer.api.campaign.SectorAPI.getPlayerFleet ( )

◆ getPlayerMemoryWithoutUpdate()

MemoryAPI com.fs.starfarer.api.campaign.SectorAPI.getPlayerMemoryWithoutUpdate ( )

Same as getCharacterData().getMemoryWithoutUpdate()

Returns

◆ getPlayerPerson()

PersonAPI com.fs.starfarer.api.campaign.SectorAPI.getPlayerPerson ( )

◆ getPlayerStats()

MutableCharacterStatsAPI com.fs.starfarer.api.campaign.SectorAPI.getPlayerStats ( )

◆ getPluginPicker()

PluginPickerAPI com.fs.starfarer.api.campaign.SectorAPI.getPluginPicker ( )

◆ getRespawnCoordinates()

Vector2f com.fs.starfarer.api.campaign.SectorAPI.getRespawnCoordinates ( )

◆ getRespawnLocation()

LocationAPI com.fs.starfarer.api.campaign.SectorAPI.getRespawnLocation ( )

◆ getRules()

RulesAPI com.fs.starfarer.api.campaign.SectorAPI.getRules ( )

◆ getScripts()

List< EveryFrameScript > com.fs.starfarer.api.campaign.SectorAPI.getScripts ( )

◆ getSeedString()

String com.fs.starfarer.api.campaign.SectorAPI.getSeedString ( )

◆ getStarSystem()

StarSystemAPI com.fs.starfarer.api.campaign.SectorAPI.getStarSystem ( String name )

◆ getStarSystems()

List< StarSystemAPI > com.fs.starfarer.api.campaign.SectorAPI.getStarSystems ( )

◆ getTransientScripts()

List< EveryFrameScript > com.fs.starfarer.api.campaign.SectorAPI.getTransientScripts ( )

◆ getUIData()

PersistentUIDataAPI com.fs.starfarer.api.campaign.SectorAPI.getUIData ( )

◆ getViewport()

ViewportAPI com.fs.starfarer.api.campaign.SectorAPI.getViewport ( )

◆ hasScript()

boolean com.fs.starfarer.api.campaign.SectorAPI.hasScript ( Class<?> clazz )

◆ hasTransientScript()

boolean com.fs.starfarer.api.campaign.SectorAPI.hasTransientScript ( Class<?> clazz )

◆ isFastForwardIteration()

boolean com.fs.starfarer.api.campaign.SectorAPI.isFastForwardIteration ( )

◆ isInFastAdvance()

boolean com.fs.starfarer.api.campaign.SectorAPI.isInFastAdvance ( )

true during the during-game-creation time passing.

Returns

◆ isInNewGameAdvance()

boolean com.fs.starfarer.api.campaign.SectorAPI.isInNewGameAdvance ( )

◆ isIronMode()

boolean com.fs.starfarer.api.campaign.SectorAPI.isIronMode ( )

◆ isLastPlayerBattleWon()

boolean com.fs.starfarer.api.campaign.SectorAPI.isLastPlayerBattleWon ( )

◆ isPaused()

boolean com.fs.starfarer.api.campaign.SectorAPI.isPaused ( )

◆ layInCourseFor()

void com.fs.starfarer.api.campaign.SectorAPI.layInCourseFor ( SectorEntityToken target )

◆ registerPlugin()

void com.fs.starfarer.api.campaign.SectorAPI.registerPlugin ( CampaignPlugin plugin )

◆ removeListener()

void com.fs.starfarer.api.campaign.SectorAPI.removeListener ( CampaignEventListener listener )

◆ removeScript()

void com.fs.starfarer.api.campaign.SectorAPI.removeScript ( EveryFrameScript script )

◆ removeScriptsOfClass()

void com.fs.starfarer.api.campaign.SectorAPI.removeScriptsOfClass ( Class c )

◆ removeStarSystem()

void com.fs.starfarer.api.campaign.SectorAPI.removeStarSystem ( StarSystemAPI system )

◆ removeStarSystemNextFrame()

void com.fs.starfarer.api.campaign.SectorAPI.removeStarSystemNextFrame ( StarSystemAPI system )

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

Parameters

system

◆ removeTransientScript()

void com.fs.starfarer.api.campaign.SectorAPI.removeTransientScript ( EveryFrameScript script )

◆ removeTransientScriptsOfClass()

void com.fs.starfarer.api.campaign.SectorAPI.removeTransientScriptsOfClass ( Class c )

◆ reportBattleFinished()

void com.fs.starfarer.api.campaign.SectorAPI.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

◆ reportBattleOccurred()

void com.fs.starfarer.api.campaign.SectorAPI.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

◆ reportEconomyMonthEnd()

void com.fs.starfarer.api.campaign.SectorAPI.reportEconomyMonthEnd ( )

◆ reportEconomyTick()

void com.fs.starfarer.api.campaign.SectorAPI.reportEconomyTick ( int iterIndex )

◆ reportEncounterLootGenerated()

void com.fs.starfarer.api.campaign.SectorAPI.reportEncounterLootGenerated	(	FleetEncounterContextPlugin	plugin,
		CargoAPI	loot
	)

◆ reportEventStage() [1/3]

void com.fs.starfarer.api.campaign.SectorAPI.reportEventStage	(	CampaignEventPlugin	event,
		String	stage,
		MessagePriority	priority
	)

Does nothing. Replaced with getIntelManager().

◆ reportEventStage() [2/3]

void com.fs.starfarer.api.campaign.SectorAPI.reportEventStage	(	CampaignEventPlugin	event,
		String	stage,
		SectorEntityToken	sendFrom,
		MessagePriority	priority
	)

Does nothing. Replaced with getIntelManager().

◆ reportEventStage() [3/3]

void com.fs.starfarer.api.campaign.SectorAPI.reportEventStage	(	CampaignEventPlugin	event,
		String	stage,
		SectorEntityToken	sendFrom,
		MessagePriority	priority,
		OnMessageDeliveryScript	onDelivery
	)

Does nothing. Replaced with getIntelManager().

◆ reportFleetDespawned()

void com.fs.starfarer.api.campaign.SectorAPI.reportFleetDespawned	(	CampaignFleetAPI	fleet,
		FleetDespawnReason	reason,
		Object	param
	)

◆ reportFleetJumped()

void com.fs.starfarer.api.campaign.SectorAPI.reportFleetJumped	(	CampaignFleetAPI	fleet,
		SectorEntityToken	from,
		JumpDestination	to
	)

◆ reportFleetReachedEntity()

void com.fs.starfarer.api.campaign.SectorAPI.reportFleetReachedEntity	(	CampaignFleetAPI	fleet,
		SectorEntityToken	entity
	)

◆ reportPlayerActivatedAbility()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerActivatedAbility	(	AbilityPlugin	ability,
		Object	param
	)

◆ reportPlayerClosedMarket()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerClosedMarket ( MarketAPI market )

◆ reportPlayerDeactivatedAbility()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerDeactivatedAbility	(	AbilityPlugin	ability,
		Object	param
	)

◆ reportPlayerDidNotTakeCargo()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerDidNotTakeCargo ( CargoAPI cargo )

◆ reportPlayerDumpedCargo()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerDumpedCargo ( CargoAPI cargo )

◆ reportPlayerEngagement()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerEngagement ( EngagementResultAPI result )

◆ reportPlayerMarketTransaction()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerMarketTransaction ( PlayerMarketTransaction transaction )

◆ reportPlayerOpenedMarket()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerOpenedMarket ( MarketAPI market )

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

Parameters

market

◆ reportPlayerOpenedMarketAndCargoUpdated()

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerOpenedMarketAndCargoUpdated ( MarketAPI market )

◆ reportPlayerReputationChange() [1/2]

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerReputationChange	(	PersonAPI	person,
		float	delta
	)

◆ reportPlayerReputationChange() [2/2]

void com.fs.starfarer.api.campaign.SectorAPI.reportPlayerReputationChange	(	String	faction,
		float	delta
	)

◆ reportShowInteractionDialog()

void com.fs.starfarer.api.campaign.SectorAPI.reportShowInteractionDialog ( InteractionDialogAPI dialog )

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

Parameters

dialog

◆ setCurrentLocation()

void com.fs.starfarer.api.campaign.SectorAPI.setCurrentLocation ( LocationAPI location )

◆ setDifficulty()

void com.fs.starfarer.api.campaign.SectorAPI.setDifficulty ( String difficulty )

◆ setFastForwardIteration()

void com.fs.starfarer.api.campaign.SectorAPI.setFastForwardIteration ( boolean isFastForwardIteration )

◆ setInFastAdvance()

void com.fs.starfarer.api.campaign.SectorAPI.setInFastAdvance ( boolean isInNewGameAdvance )

◆ setInNewGameAdvance()

void com.fs.starfarer.api.campaign.SectorAPI.setInNewGameAdvance ( boolean isInNewGameAdvance )

◆ setLastPlayerBattleTimestamp()

void com.fs.starfarer.api.campaign.SectorAPI.setLastPlayerBattleTimestamp ( long lastPlayerBattleTimestamp )

◆ setLastPlayerBattleWon()

void com.fs.starfarer.api.campaign.SectorAPI.setLastPlayerBattleWon ( boolean lastPlayerBattleWon )

◆ setPaused()

void com.fs.starfarer.api.campaign.SectorAPI.setPaused ( boolean paused )

◆ setPlayerBattleSeed()

void com.fs.starfarer.api.campaign.SectorAPI.setPlayerBattleSeed ( long nextPlayerBattleSeed )

◆ setPlayerFleet()

void com.fs.starfarer.api.campaign.SectorAPI.setPlayerFleet ( CampaignFleetAPI playerFleet )

◆ setRespawnLocation()

void com.fs.starfarer.api.campaign.SectorAPI.setRespawnLocation ( LocationAPI respawnLocation )

◆ setSeedString()

void com.fs.starfarer.api.campaign.SectorAPI.setSeedString ( String seedString )

◆ unregisterPlugin()

void com.fs.starfarer.api.campaign.SectorAPI.unregisterPlugin ( String pluginId )

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

src/com/fs/starfarer/api/campaign/SectorAPI.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addListener()

◆ addListenerWithTimeout()

◆ addPing() [1/3]

◆ addPing() [2/3]

◆ addPing() [3/3]

◆ addScript()

◆ addTransientListener()

◆ addTransientScript()

◆ adjustPlayerReputation() [1/2]

◆ adjustPlayerReputation() [2/2]

◆ createNascentGravityWell()

◆ createStarSystem()

◆ doHyperspaceTransition() [1/2]

◆ doHyperspaceTransition() [2/2]

◆ genUID()

◆ getAllEmptyVariantIds()

◆ getAllFactions()

◆ getAllFighterWingIds()

◆ getAllListeners()

◆ getAllLocations()

◆ getAllWeaponIds()

◆ getAutofitVariants()

◆ getCampaignUI()

◆ getCharacterData()

◆ getClock()

◆ getCurrentLocation()

◆ getCustomEntitiesWithTag()

◆ getDifficulty()

◆ getEconomy()

◆ getEntitiesWithTag()

◆ getEntityById()

◆ getEventManager()

◆ getFaction()

◆ getGenericPlugins()

◆ getHyperspace()

◆ getImportantPeople()

◆ getIntel()

◆ getIntelManager()

◆ getLastPlayerBattleTimestamp()

◆ getListenerManager()

◆ getMemory()

◆ getMemoryWithoutUpdate()

◆ getMousedOverEntity()

◆ getPersistentData()

◆ getPlayerBattleSeed()

◆ getPlayerFaction()

◆ getPlayerFleet()

◆ getPlayerMemoryWithoutUpdate()

◆ getPlayerPerson()

◆ getPlayerStats()

◆ getPluginPicker()

◆ getRespawnCoordinates()

◆ getRespawnLocation()

◆ getRules()

◆ getScripts()

◆ getSeedString()

◆ getStarSystem()

◆ getStarSystems()

◆ getTransientScripts()

◆ getUIData()

◆ getViewport()

◆ hasScript()

◆ hasTransientScript()

◆ isFastForwardIteration()

◆ isInFastAdvance()

◆ isInNewGameAdvance()

◆ isIronMode()

◆ isLastPlayerBattleWon()

◆ isPaused()

◆ layInCourseFor()

◆ registerPlugin()

◆ removeListener()

◆ removeScript()

◆ removeScriptsOfClass()

◆ removeStarSystem()

◆ removeStarSystemNextFrame()

◆ removeTransientScript()