com.fs.starfarer.api.combat.BattleCreationContext Class Reference

Public Member Functions
	BattleCreationContext (CampaignFleetAPI playerFleet, FleetGoal playerGoal, CampaignFleetAPI otherFleet, FleetGoal otherGoal)
int	getPlayerCommandPoints ()
void	setPlayerCommandPoints (int playerCommandPoints)
CampaignFleetAPI	getPlayerFleet ()
FleetGoal	getPlayerGoal ()
CampaignFleetAPI	getOtherFleet ()
FleetGoal	getOtherGoal ()
float	getPursuitRangeModifier ()
void	setPursuitRangeModifier (float pursuitRangeModifier)
float	getInitialDeploymentBurnDuration ()
void	setInitialDeploymentBurnDuration (float initialDeploymentBurnDuration)
float	getNormalDeploymentBurnDuration ()
void	setNormalDeploymentBurnDuration (float normalDeploymentBurnDuration)
float	getEscapeDeploymentBurnDuration ()
void	setEscapeDeploymentBurnDuration (float escapeDeploymentBurnDuration)
float	getStandoffRange ()
void	setStandoffRange (float standoffRange)
float	getInitialEscapeRange ()
void	setInitialEscapeRange (float initialEscapeRange)
float	getFlankDeploymentDistance ()
void	setFlankDeploymentDistance (float sideDeploymentDistance)
float	getInitialStepSize ()
void	setInitialStepSize (float initialStepSize)
float	getInitialNumSteps ()
void	setInitialNumSteps (float initialNumSteps)
float	getExtraEnemyStandoffRange ()

Public Attributes
float	extraEnemyStandoffRange = 0f
boolean	aiRetreatAllowed = true
boolean	objectivesAllowed = true
boolean	forceObjectivesOnMap = false
boolean	enemyDeployAll = false
boolean	fightToTheLast = false

Detailed Description

Definition at line 9 of file BattleCreationContext.java.

Constructor & Destructor Documentation

BattleCreationContext()

com.fs.starfarer.api.combat.BattleCreationContext.BattleCreationContext	(	CampaignFleetAPI	playerFleet,
		FleetGoal	playerGoal,
		CampaignFleetAPI	otherFleet,
		FleetGoal	otherGoal )

Definition at line 43 of file BattleCreationContext.java.

Member Function Documentation

getEscapeDeploymentBurnDuration()

float com.fs.starfarer.api.combat.BattleCreationContext.getEscapeDeploymentBurnDuration

(

)

Definition at line 108 of file BattleCreationContext.java.

getExtraEnemyStandoffRange()

float com.fs.starfarer.api.combat.BattleCreationContext.getExtraEnemyStandoffRange

(

)

Definition at line 156 of file BattleCreationContext.java.

getFlankDeploymentDistance()

float com.fs.starfarer.api.combat.BattleCreationContext.getFlankDeploymentDistance

(

)

Definition at line 132 of file BattleCreationContext.java.

getInitialDeploymentBurnDuration()

float com.fs.starfarer.api.combat.BattleCreationContext.getInitialDeploymentBurnDuration

(

)

Definition at line 92 of file BattleCreationContext.java.

getInitialEscapeRange()

float com.fs.starfarer.api.combat.BattleCreationContext.getInitialEscapeRange

(

)

Definition at line 124 of file BattleCreationContext.java.

getInitialNumSteps()

float com.fs.starfarer.api.combat.BattleCreationContext.getInitialNumSteps

(

)

Definition at line 148 of file BattleCreationContext.java.

getInitialStepSize()

float com.fs.starfarer.api.combat.BattleCreationContext.getInitialStepSize

(

)

Definition at line 140 of file BattleCreationContext.java.

getNormalDeploymentBurnDuration()

float com.fs.starfarer.api.combat.BattleCreationContext.getNormalDeploymentBurnDuration

(

)

Definition at line 100 of file BattleCreationContext.java.

getOtherFleet()

CampaignFleetAPI com.fs.starfarer.api.combat.BattleCreationContext.getOtherFleet

(

)

Definition at line 76 of file BattleCreationContext.java.

getOtherGoal()

FleetGoal com.fs.starfarer.api.combat.BattleCreationContext.getOtherGoal

(

)

Definition at line 80 of file BattleCreationContext.java.

getPlayerCommandPoints()

int com.fs.starfarer.api.combat.BattleCreationContext.getPlayerCommandPoints

(

)

Definition at line 60 of file BattleCreationContext.java.

getPlayerFleet()

CampaignFleetAPI com.fs.starfarer.api.combat.BattleCreationContext.getPlayerFleet

(

)

Definition at line 68 of file BattleCreationContext.java.

getPlayerGoal()

FleetGoal com.fs.starfarer.api.combat.BattleCreationContext.getPlayerGoal

(

)

Definition at line 72 of file BattleCreationContext.java.

getPursuitRangeModifier()

float com.fs.starfarer.api.combat.BattleCreationContext.getPursuitRangeModifier

(

)

Definition at line 84 of file BattleCreationContext.java.

getStandoffRange()

float com.fs.starfarer.api.combat.BattleCreationContext.getStandoffRange

(

)

Definition at line 116 of file BattleCreationContext.java.

setEscapeDeploymentBurnDuration()

void com.fs.starfarer.api.combat.BattleCreationContext.setEscapeDeploymentBurnDuration

(

float

escapeDeploymentBurnDuration

)

Definition at line 112 of file BattleCreationContext.java.

setFlankDeploymentDistance()

void com.fs.starfarer.api.combat.BattleCreationContext.setFlankDeploymentDistance

(

float

sideDeploymentDistance

)

Definition at line 136 of file BattleCreationContext.java.

setInitialDeploymentBurnDuration()

void com.fs.starfarer.api.combat.BattleCreationContext.setInitialDeploymentBurnDuration

(

float

initialDeploymentBurnDuration

)

Definition at line 96 of file BattleCreationContext.java.

setInitialEscapeRange()

void com.fs.starfarer.api.combat.BattleCreationContext.setInitialEscapeRange

(

float

initialEscapeRange

)

Definition at line 128 of file BattleCreationContext.java.

setInitialNumSteps()

void com.fs.starfarer.api.combat.BattleCreationContext.setInitialNumSteps

(

float

initialNumSteps

)

Definition at line 152 of file BattleCreationContext.java.

setInitialStepSize()

void com.fs.starfarer.api.combat.BattleCreationContext.setInitialStepSize

(

float

initialStepSize

)

Definition at line 144 of file BattleCreationContext.java.

setNormalDeploymentBurnDuration()

void com.fs.starfarer.api.combat.BattleCreationContext.setNormalDeploymentBurnDuration

(

float

normalDeploymentBurnDuration

)

Definition at line 104 of file BattleCreationContext.java.

setPlayerCommandPoints()

void com.fs.starfarer.api.combat.BattleCreationContext.setPlayerCommandPoints

(

int

playerCommandPoints

)

Definition at line 64 of file BattleCreationContext.java.

setPursuitRangeModifier()

void com.fs.starfarer.api.combat.BattleCreationContext.setPursuitRangeModifier

(

float

pursuitRangeModifier

)

Definition at line 88 of file BattleCreationContext.java.

setStandoffRange()

void com.fs.starfarer.api.combat.BattleCreationContext.setStandoffRange

(

float

standoffRange

)

Definition at line 120 of file BattleCreationContext.java.

Member Data Documentation

aiRetreatAllowed

boolean com.fs.starfarer.api.combat.BattleCreationContext.aiRetreatAllowed = true

Definition at line 34 of file BattleCreationContext.java.

enemyDeployAll

boolean com.fs.starfarer.api.combat.BattleCreationContext.enemyDeployAll = false

Definition at line 37 of file BattleCreationContext.java.

extraEnemyStandoffRange

float com.fs.starfarer.api.combat.BattleCreationContext.extraEnemyStandoffRange = 0f

Definition at line 30 of file BattleCreationContext.java.

fightToTheLast

boolean com.fs.starfarer.api.combat.BattleCreationContext.fightToTheLast = false

Definition at line 41 of file BattleCreationContext.java.

forceObjectivesOnMap

boolean com.fs.starfarer.api.combat.BattleCreationContext.forceObjectivesOnMap = false

Definition at line 36 of file BattleCreationContext.java.

objectivesAllowed

boolean com.fs.starfarer.api.combat.BattleCreationContext.objectivesAllowed = true

Definition at line 35 of file BattleCreationContext.java.

---

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

• src/com/fs/starfarer/api/combat/BattleCreationContext.java