Package com.fs.starfarer.api.combat

Class BattleCreationContext

java.lang.Object

com.fs.starfarer.api.combat.BattleCreationContext

public class BattleCreationContext
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	aiRetreatAllowed
boolean	enemyDeployAll
float	extraEnemyStandoffRange
boolean	fightToTheLast
boolean	forceObjectivesOnMap
boolean	objectivesAllowed

Constructor Summary

Constructors

Constructor	Description
BattleCreationContext(CampaignFleetAPI playerFleet, FleetGoal playerGoal, CampaignFleetAPI otherFleet, FleetGoal otherGoal)

Method Summary

Modifier and Type	Method	Description
float	getEscapeDeploymentBurnDuration()
float	getExtraEnemyStandoffRange()
float	getFlankDeploymentDistance()
float	getInitialDeploymentBurnDuration()
float	getInitialEscapeRange()
float	getInitialNumSteps()
float	getInitialStepSize()
float	getNormalDeploymentBurnDuration()
CampaignFleetAPI	getOtherFleet()
FleetGoal	getOtherGoal()
int	getPlayerCommandPoints()
CampaignFleetAPI	getPlayerFleet()
FleetGoal	getPlayerGoal()
float	getPursuitRangeModifier()
float	getStandoffRange()
void	setEscapeDeploymentBurnDuration(float escapeDeploymentBurnDuration)
void	setFlankDeploymentDistance(float sideDeploymentDistance)
void	setInitialDeploymentBurnDuration(float initialDeploymentBurnDuration)
void	setInitialEscapeRange(float initialEscapeRange)
void	setInitialNumSteps(float initialNumSteps)
void	setInitialStepSize(float initialStepSize)
void	setNormalDeploymentBurnDuration(float normalDeploymentBurnDuration)
void	setPlayerCommandPoints(int playerCommandPoints)
void	setPursuitRangeModifier(float pursuitRangeModifier)
void	setStandoffRange(float standoffRange)

Methods inherited from class java.lang.Object

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

Field Details

extraEnemyStandoffRange

public float extraEnemyStandoffRange

aiRetreatAllowed

public boolean aiRetreatAllowed

objectivesAllowed

public boolean objectivesAllowed

forceObjectivesOnMap

public boolean forceObjectivesOnMap

enemyDeployAll

public boolean enemyDeployAll

fightToTheLast

public boolean fightToTheLast

Constructor Details

BattleCreationContext

public BattleCreationContext(CampaignFleetAPI playerFleet,
 FleetGoal playerGoal,
 CampaignFleetAPI otherFleet,
 FleetGoal otherGoal)

Method Details

getPlayerCommandPoints

public int getPlayerCommandPoints()

setPlayerCommandPoints

public void setPlayerCommandPoints(int playerCommandPoints)

getPlayerFleet

public CampaignFleetAPI getPlayerFleet()

getPlayerGoal

public FleetGoal getPlayerGoal()

getOtherFleet

public CampaignFleetAPI getOtherFleet()

getOtherGoal

public FleetGoal getOtherGoal()

getPursuitRangeModifier

public float getPursuitRangeModifier()

setPursuitRangeModifier

public void setPursuitRangeModifier(float pursuitRangeModifier)

getInitialDeploymentBurnDuration

public float getInitialDeploymentBurnDuration()

setInitialDeploymentBurnDuration

public void setInitialDeploymentBurnDuration(float initialDeploymentBurnDuration)

getNormalDeploymentBurnDuration

public float getNormalDeploymentBurnDuration()

setNormalDeploymentBurnDuration

public void setNormalDeploymentBurnDuration(float normalDeploymentBurnDuration)

getEscapeDeploymentBurnDuration

public float getEscapeDeploymentBurnDuration()

setEscapeDeploymentBurnDuration

public void setEscapeDeploymentBurnDuration(float escapeDeploymentBurnDuration)

getStandoffRange

public float getStandoffRange()

setStandoffRange

public void setStandoffRange(float standoffRange)

getInitialEscapeRange

public float getInitialEscapeRange()

setInitialEscapeRange

public void setInitialEscapeRange(float initialEscapeRange)

getFlankDeploymentDistance

public float getFlankDeploymentDistance()

setFlankDeploymentDistance

public void setFlankDeploymentDistance(float sideDeploymentDistance)

getInitialStepSize

public float getInitialStepSize()

setInitialStepSize

public void setInitialStepSize(float initialStepSize)

getInitialNumSteps

public float getInitialNumSteps()

setInitialNumSteps

public void setInitialNumSteps(float initialNumSteps)

getExtraEnemyStandoffRange

public float getExtraEnemyStandoffRange()