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

Class WarSimScript

java.lang.Object

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

All Implemented Interfaces:

ObjectiveEventListener, EveryFrameScript

public class WarSimScript
extends Object
implements EveryFrameScript, ObjectiveEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WarSimScript.LocationDanger

Field Summary

Fields

Modifier and Type	Field	Description
static final float	CHECK_DAYS
static final float	CHECK_PROB
static final String	KEY
protected List<StarSystemAPI>	queue
protected TimeoutTracker<String>	timeouts

Constructor Summary

Constructors

Constructor	Description
WarSimScript()

Method Summary

Modifier and Type	Method	Description
protected void	addObjectiveActionResponse(SectorEntityToken objective, FactionAPI faction, FactionAPI enemy)
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
protected String	getBuildSimTimeoutId(SectorEntityToken objective)
protected String	getControlSimTimeoutId(SectorEntityToken objective)
protected String	getControlTimeoutId(SectorEntityToken objective, FactionAPI faction)
static WarSimScript.LocationDanger	getDangerFor(float factionStrength, float enemyStrength)
static WarSimScript.LocationDanger	getDangerFor(FactionAPI faction, StarSystemAPI system)
static WarSimScript.LocationDanger	getDangerFor(String factionId, StarSystemAPI system)
static float	getEnemyStrength(FactionAPI faction, StarSystemAPI system)
static float	getEnemyStrength(FactionAPI faction, StarSystemAPI system, boolean assumeHostileToPlayer)
static float	getEnemyStrength(String factionId, StarSystemAPI system)
static float	getEnemyStrength(String factionId, StarSystemAPI system, boolean assumeHostileToPlayer)
static float	getFactionStrength(FactionAPI faction, StarSystemAPI system)
static float	getFactionStrength(String factionId, StarSystemAPI system)
static CountingMap<FactionAPI>	getFactionStrengths(StarSystemAPI system)
static WarSimScript	getInstance()
static float	getRelativeEnemyStrength(String factionId, StarSystemAPI system)
static float	getRelativeFactionStrength(String factionId, StarSystemAPI system)
protected String	getStarSystemTimeoutId(StarSystemAPI system)
static float	getStationStrength(FactionAPI faction, StarSystemAPI system, SectorEntityToken from)
TimeoutTracker<String>	getTimeouts()
static boolean	isAlreadyFightingFor(SectorEntityToken objective, FactionAPI faction)
boolean	isDone()
void	processStarSystem(StarSystemAPI system)
protected Object	readResolve()
static void	removeFightOrdersFor(SectorEntityToken target, FactionAPI faction)
static void	removeNoFightingTimeoutForObjective(SectorEntityToken objective, FactionAPI faction)
void	reportObjectiveChangedHands(SectorEntityToken objective, FactionAPI from, FactionAPI to)
void	reportObjectiveDestroyed(SectorEntityToken objective, SectorEntityToken stableLocation, FactionAPI enemy)
boolean	runWhilePaused()
static void	setNoFightingForObjective(SectorEntityToken objective, FactionAPI faction, float timeout)
protected boolean	wantsToOwnObjective(FactionAPI faction, CountingMap<FactionAPI> str, SectorEntityToken o)	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

CHECK_DAYS

public static final float CHECK_DAYS

See Also:

• Constant Field Values

CHECK_PROB

public static final float CHECK_PROB

See Also:

• Constant Field Values

timeouts

protected TimeoutTracker<String> timeouts

queue

protected List<StarSystemAPI> queue

Constructor Details

WarSimScript

public WarSimScript()

Method Details

getInstance

public static WarSimScript getInstance()

readResolve

protected Object readResolve()

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

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

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

processStarSystem

public void processStarSystem(StarSystemAPI system)

wantsToOwnObjective

protected boolean wantsToOwnObjective(FactionAPI faction,
 CountingMap<FactionAPI> str,
 SectorEntityToken o)

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:

reportObjectiveChangedHands

public void reportObjectiveChangedHands(SectorEntityToken objective,
 FactionAPI from,
 FactionAPI to)

Specified by:

reportObjectiveChangedHands in interface ObjectiveEventListener

reportObjectiveDestroyed

public void reportObjectiveDestroyed(SectorEntityToken objective,
 SectorEntityToken stableLocation,
 FactionAPI enemy)

Specified by:

reportObjectiveDestroyed in interface ObjectiveEventListener

getStarSystemTimeoutId

protected String getStarSystemTimeoutId(StarSystemAPI system)

getBuildSimTimeoutId

protected String getBuildSimTimeoutId(SectorEntityToken objective)

getControlSimTimeoutId

protected String getControlSimTimeoutId(SectorEntityToken objective)

getControlTimeoutId

protected String getControlTimeoutId(SectorEntityToken objective,
 FactionAPI faction)

addObjectiveActionResponse

protected void addObjectiveActionResponse(SectorEntityToken objective,
 FactionAPI faction,
 FactionAPI enemy)

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

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

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

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

getFactionStrengths

public static CountingMap<FactionAPI> getFactionStrengths(StarSystemAPI system)

getRelativeEnemyStrength

public static float getRelativeEnemyStrength(String factionId,
 StarSystemAPI system)

getRelativeFactionStrength

public static float getRelativeFactionStrength(String factionId,
 StarSystemAPI system)

getEnemyStrength

public static float getEnemyStrength(String factionId,
 StarSystemAPI system)

getEnemyStrength

public static float getEnemyStrength(FactionAPI faction,
 StarSystemAPI system)

getEnemyStrength

public static float getEnemyStrength(String factionId,
 StarSystemAPI system,
 boolean assumeHostileToPlayer)

getEnemyStrength

public static float getEnemyStrength(FactionAPI faction,
 StarSystemAPI system,
 boolean assumeHostileToPlayer)

getFactionStrength

public static float getFactionStrength(String factionId,
 StarSystemAPI system)

getFactionStrength

public static float getFactionStrength(FactionAPI faction,
 StarSystemAPI system)

getStationStrength

public static float getStationStrength(FactionAPI faction,
 StarSystemAPI system,
 SectorEntityToken from)

getTimeouts

public TimeoutTracker<String> getTimeouts()

removeFightOrdersFor

public static void removeFightOrdersFor(SectorEntityToken target,
 FactionAPI faction)

setNoFightingForObjective

public static void setNoFightingForObjective(SectorEntityToken objective,
 FactionAPI faction,
 float timeout)

removeNoFightingTimeoutForObjective

public static void removeNoFightingTimeoutForObjective(SectorEntityToken objective,
 FactionAPI faction)

isAlreadyFightingFor

public static boolean isAlreadyFightingFor(SectorEntityToken objective,
 FactionAPI faction)

getDangerFor

public static WarSimScript.LocationDanger getDangerFor(FactionAPI faction,
 StarSystemAPI system)

getDangerFor

public static WarSimScript.LocationDanger getDangerFor(String factionId,
 StarSystemAPI system)

getDangerFor

public static WarSimScript.LocationDanger getDangerFor(float factionStrength,
 float enemyStrength)