com.fs.starfarer.api.impl.campaign.command.WarSimScript Class Reference

Inheritance diagram for com.fs.starfarer.api.impl.campaign.command.WarSimScript:

Collaboration diagram for com.fs.starfarer.api.impl.campaign.command.WarSimScript:

Classes
enum	LocationDanger

Public Member Functions
	WarSimScript ()
void	advance (float amount)
void	processStarSystem (StarSystemAPI system)
void	reportObjectiveChangedHands (SectorEntityToken objective, FactionAPI from, FactionAPI to)
void	reportObjectiveDestroyed (SectorEntityToken objective, SectorEntityToken stableLocation, FactionAPI enemy)
boolean	isDone ()
boolean	runWhilePaused ()
TimeoutTracker< String >	getTimeouts ()
Public Member Functions inherited from com.fs.starfarer.api.EveryFrameScript
Public Member Functions inherited from com.fs.starfarer.api.campaign.listeners.ObjectiveEventListener

Static Public Member Functions
static WarSimScript	getInstance ()
static CountingMap< FactionAPI >	getFactionStrengths (StarSystemAPI system)
static float	getRelativeEnemyStrength (String factionId, StarSystemAPI system)
static float	getRelativeFactionStrength (String factionId, StarSystemAPI system)
static float	getEnemyStrength (String factionId, StarSystemAPI system)
static float	getEnemyStrength (FactionAPI faction, StarSystemAPI system)
static float	getEnemyStrength (String factionId, StarSystemAPI system, boolean assumeHostileToPlayer)
static float	getEnemyStrength (FactionAPI faction, StarSystemAPI system, boolean assumeHostileToPlayer)
static float	getFactionStrength (String factionId, StarSystemAPI system)
static float	getFactionStrength (FactionAPI faction, StarSystemAPI system)
static float	getStationStrength (FactionAPI faction, StarSystemAPI system, SectorEntityToken from)
static void	removeFightOrdersFor (SectorEntityToken target, FactionAPI faction)
static void	setNoFightingForObjective (SectorEntityToken objective, FactionAPI faction, float timeout)
static void	removeNoFightingTimeoutForObjective (SectorEntityToken objective, FactionAPI faction)
static boolean	isAlreadyFightingFor (SectorEntityToken objective, FactionAPI faction)
static LocationDanger	getDangerFor (FactionAPI faction, StarSystemAPI system)
static LocationDanger	getDangerFor (String factionId, StarSystemAPI system)
static LocationDanger	getDangerFor (float factionStrength, float enemyStrength)

Static Public Attributes
static final String	KEY = "$core_warSimScript"
static final float	CHECK_DAYS = 10f
static final float	CHECK_PROB = 0.5f

Protected Member Functions
Object	readResolve ()
boolean	wantsToOwnObjective (FactionAPI faction, CountingMap< FactionAPI > str, SectorEntityToken o)
String	getStarSystemTimeoutId (StarSystemAPI system)
String	getBuildSimTimeoutId (SectorEntityToken objective)
String	getControlSimTimeoutId (SectorEntityToken objective)
String	getControlTimeoutId (SectorEntityToken objective, FactionAPI faction)
void	addObjectiveActionResponse (SectorEntityToken objective, FactionAPI faction, FactionAPI enemy)

Protected Attributes
TimeoutTracker< String >	timeouts = new TimeoutTracker<String>()
List< StarSystemAPI >	queue = new ArrayList<StarSystemAPI>()

Detailed Description

Definition at line 37 of file WarSimScript.java.

Constructor & Destructor Documentation

WarSimScript()

com.fs.starfarer.api.impl.campaign.command.WarSimScript.WarSimScript

(

)

Definition at line 87 of file WarSimScript.java.

Member Function Documentation

addObjectiveActionResponse()

void com.fs.starfarer.api.impl.campaign.command.WarSimScript.addObjectiveActionResponse ( SectorEntityToken objective, FactionAPI faction, FactionAPI enemy )

protected

Definition at line 347 of file WarSimScript.java.

advance()

void com.fs.starfarer.api.impl.campaign.command.WarSimScript.advance

(

float

amount

)

Use SectorAPI.getClock() to convert to campaign days.

Parameters

amount

seconds elapsed during the last frame.

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 104 of file WarSimScript.java.

getBuildSimTimeoutId()

String com.fs.starfarer.api.impl.campaign.command.WarSimScript.getBuildSimTimeoutId ( SectorEntityToken objective )

protected

Definition at line 332 of file WarSimScript.java.

getControlSimTimeoutId()

String com.fs.starfarer.api.impl.campaign.command.WarSimScript.getControlSimTimeoutId ( SectorEntityToken objective )

protected

Definition at line 337 of file WarSimScript.java.

getControlTimeoutId()

String com.fs.starfarer.api.impl.campaign.command.WarSimScript.getControlTimeoutId ( SectorEntityToken objective, FactionAPI faction )

protected

Definition at line 342 of file WarSimScript.java.

getDangerFor() [1/3]

static LocationDanger com.fs.starfarer.api.impl.campaign.command.WarSimScript.getDangerFor ( FactionAPI faction, StarSystemAPI system )

static

Definition at line 586 of file WarSimScript.java.

getDangerFor() [2/3]

static LocationDanger com.fs.starfarer.api.impl.campaign.command.WarSimScript.getDangerFor ( float factionStrength, float enemyStrength )

static

Definition at line 594 of file WarSimScript.java.

getDangerFor() [3/3]

static LocationDanger com.fs.starfarer.api.impl.campaign.command.WarSimScript.getDangerFor ( String factionId, StarSystemAPI system )

static

Definition at line 590 of file WarSimScript.java.

getEnemyStrength() [1/4]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getEnemyStrength ( FactionAPI faction, StarSystemAPI system )

static

Definition at line 438 of file WarSimScript.java.

getEnemyStrength() [2/4]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getEnemyStrength ( FactionAPI faction, StarSystemAPI system, boolean assumeHostileToPlayer )

static

Definition at line 444 of file WarSimScript.java.

getEnemyStrength() [3/4]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getEnemyStrength ( String factionId, StarSystemAPI system )

static

Definition at line 435 of file WarSimScript.java.

getEnemyStrength() [4/4]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getEnemyStrength ( String factionId, StarSystemAPI system, boolean assumeHostileToPlayer )

static

Definition at line 441 of file WarSimScript.java.

getFactionStrength() [1/2]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getFactionStrength ( FactionAPI faction, StarSystemAPI system )

static

Definition at line 476 of file WarSimScript.java.

getFactionStrength() [2/2]

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getFactionStrength ( String factionId, StarSystemAPI system )

static

Definition at line 473 of file WarSimScript.java.

getFactionStrengths()

static CountingMap< FactionAPI > com.fs.starfarer.api.impl.campaign.command.WarSimScript.getFactionStrengths ( StarSystemAPI system )

static

Definition at line 387 of file WarSimScript.java.

getInstance()

static WarSimScript com.fs.starfarer.api.impl.campaign.command.WarSimScript.getInstance ( )

static

Definition at line 78 of file WarSimScript.java.

getRelativeEnemyStrength()

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getRelativeEnemyStrength ( String factionId, StarSystemAPI system )

static

Definition at line 421 of file WarSimScript.java.

getRelativeFactionStrength()

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getRelativeFactionStrength ( String factionId, StarSystemAPI system )

static

Definition at line 428 of file WarSimScript.java.

getStarSystemTimeoutId()

String com.fs.starfarer.api.impl.campaign.command.WarSimScript.getStarSystemTimeoutId ( StarSystemAPI system )

protected

Definition at line 327 of file WarSimScript.java.

getStationStrength()

static float com.fs.starfarer.api.impl.campaign.command.WarSimScript.getStationStrength ( FactionAPI faction, StarSystemAPI system, SectorEntityToken from )

static

Definition at line 522 of file WarSimScript.java.

getTimeouts()

TimeoutTracker< String > com.fs.starfarer.api.impl.campaign.command.WarSimScript.getTimeouts

(

)

Definition at line 540 of file WarSimScript.java.

isAlreadyFightingFor()

static boolean com.fs.starfarer.api.impl.campaign.command.WarSimScript.isAlreadyFightingFor ( SectorEntityToken objective, FactionAPI faction )

static

Definition at line 572 of file WarSimScript.java.

isDone()

boolean com.fs.starfarer.api.impl.campaign.command.WarSimScript.isDone

(

)

Returns

true when the script is finished and can be cleaned up by the engine.

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 376 of file WarSimScript.java.

processStarSystem()

void com.fs.starfarer.api.impl.campaign.command.WarSimScript.processStarSystem

(

StarSystemAPI

system

)

Definition at line 125 of file WarSimScript.java.

readResolve()

Object com.fs.starfarer.api.impl.campaign.command.WarSimScript.readResolve ( )

protected

Definition at line 97 of file WarSimScript.java.

removeFightOrdersFor()

static void com.fs.starfarer.api.impl.campaign.command.WarSimScript.removeFightOrdersFor ( SectorEntityToken target, FactionAPI faction )

static

Definition at line 545 of file WarSimScript.java.

removeNoFightingTimeoutForObjective()

static void com.fs.starfarer.api.impl.campaign.command.WarSimScript.removeNoFightingTimeoutForObjective ( SectorEntityToken objective, FactionAPI faction )

static

Definition at line 566 of file WarSimScript.java.

reportObjectiveChangedHands()

void com.fs.starfarer.api.impl.campaign.command.WarSimScript.reportObjectiveChangedHands	(	SectorEntityToken	objective,
		FactionAPI	from,
		FactionAPI	to )

Implements com.fs.starfarer.api.campaign.listeners.ObjectiveEventListener.

Definition at line 314 of file WarSimScript.java.

reportObjectiveDestroyed()

void com.fs.starfarer.api.impl.campaign.command.WarSimScript.reportObjectiveDestroyed	(	SectorEntityToken	objective,
		SectorEntityToken	stableLocation,
		FactionAPI	enemy )

Implements com.fs.starfarer.api.campaign.listeners.ObjectiveEventListener.

Definition at line 319 of file WarSimScript.java.

runWhilePaused()

boolean com.fs.starfarer.api.impl.campaign.command.WarSimScript.runWhilePaused

(

)

Returns

whether advance() should be called while the campaign engine is paused.

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 380 of file WarSimScript.java.

setNoFightingForObjective()

static void com.fs.starfarer.api.impl.campaign.command.WarSimScript.setNoFightingForObjective ( SectorEntityToken objective, FactionAPI faction, float timeout )

static

Definition at line 557 of file WarSimScript.java.

wantsToOwnObjective()

boolean com.fs.starfarer.api.impl.campaign.command.WarSimScript.wantsToOwnObjective ( FactionAPI faction, CountingMap< FactionAPI > str, SectorEntityToken o )

protected

If it doesn't already own it, it's owned by an enemy, and the faction either has the closest market to it or is the strongest in-system faction.

Or: owned by a non-hostile faction that has no colony presence in the system, and this faction does

Parameters

faction
str
o

Returns

Definition at line 246 of file WarSimScript.java.

Member Data Documentation

CHECK_DAYS

final float com.fs.starfarer.api.impl.campaign.command.WarSimScript.CHECK_DAYS = 10f

static

Definition at line 74 of file WarSimScript.java.

CHECK_PROB

final float com.fs.starfarer.api.impl.campaign.command.WarSimScript.CHECK_PROB = 0.5f

static

Definition at line 75 of file WarSimScript.java.

KEY

final String com.fs.starfarer.api.impl.campaign.command.WarSimScript.KEY = "$core_warSimScript"

static

Definition at line 72 of file WarSimScript.java.

queue

List<StarSystemAPI> com.fs.starfarer.api.impl.campaign.command.WarSimScript.queue = new ArrayList<StarSystemAPI>()

protected

Definition at line 85 of file WarSimScript.java.

timeouts

TimeoutTracker<String> com.fs.starfarer.api.impl.campaign.command.WarSimScript.timeouts = new TimeoutTracker<String>()

protected

Definition at line 83 of file WarSimScript.java.

---

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

• src/com/fs/starfarer/api/impl/campaign/command/WarSimScript.java