com.fs.starfarer.api.combat.CombatFleetManagerAPI Interface Reference

Classes
interface	AssignmentInfo

Public Member Functions
ShipAPI	spawnShipOrWing (String specId, Vector2f location, float facing)
ShipAPI	spawnShipOrWing (String specId, Vector2f location, float facing, float initialBurnDur)
ShipAPI	spawnFleetMember (FleetMemberAPI member, Vector2f location, float facing, float initialBurnDur)
ShipAPI	getShipFor (FleetMemberAPI fleetMember)
List< FleetMemberAPI >	getDeployedCopy ()
List< FleetMemberAPI >	getReservesCopy ()
DeployedFleetMemberAPI	getDeployedFleetMember (ShipAPI ship)
DeployedFleetMemberAPI	getDeployedFleetMemberEvenIfDisabled (ShipAPI ship)
AssignmentTargetAPI	createWaypoint (Vector2f location, boolean ally)
FleetGoal	getGoal ()
void	addToReserves (FleetMemberAPI member)
void	removeFromReserves (FleetMemberAPI member)
CombatTaskManagerAPI	getTaskManager (boolean ally)
boolean	isOnlyTimidOrNonCombatDeployed ()
List< FleetMemberAPI >	getDisabledCopy ()
List< FleetMemberAPI >	getDestroyedCopy ()
List< FleetMemberAPI >	getRetreatedCopy ()
boolean	isSuppressDeploymentMessages ()
void	setSuppressDeploymentMessages (boolean suppressDeploymentMessages)
boolean	isDefendingStation ()
List< DeployedFleetMemberAPI >	getStations ()
List< DeployedFleetMemberAPI >	getDeployedCopyDFM ()
int	getOwner ()
void	setDefaultCommander (PersonAPI defaultCommander)
PersonAPI	getDefaultCommander ()
PersonAPI	getFleetCommander ()
int	getMaxStrength ()
boolean	isDeployedStation ()
void	setDeployedStation (boolean deployedStation)
void	setDeploymentYOffset (float deploymentYOffset)
float	getDeploymentYOffset ()
float	getEnemyCleanDisengageProgress ()
float	getEnemyCleanDisengageThreshold ()
float	getEnemyCleanDisengagePoints ()
boolean	canEnemyDisengageCleanly ()
List< PersonAPI >	getAllFleetCommanders ()
PersonAPI	getFleetCommanderPreferPlayer ()
List< DeployedFleetMemberAPI >	getAllEverDeployedCopy ()
boolean	isCanForceShipsToEngageWhenBattleClearlyLost ()
void	setCanForceShipsToEngageWhenBattleClearlyLost (boolean canForceShipsToEngageWhenBattleClearlyLost)
ShipAPI	spawnShipOrWing (String specId, Vector2f location, float facing, float initialBurnDur, PersonAPI captain)
Map< DeployedFleetMemberAPI, DeployedFleetMemberAPI >	getShardToOriginalShipMap ()
DeployedFleetMemberAPI	getDeployedFleetMemberFromAllEverDeployed (ShipAPI ship)
ShipAPI	getShipFor (PersonAPI captain)
FleetMemberAPI	getBiggestStationDeployedOrNot ()
AdmiralAIPlugin	getAdmiralAI ()
void	setAdmiralAI (AdmiralAIPlugin admiralAI)
void	removeDeployed (ShipAPI ship, boolean retreated)
void	setMaxStrength (int maxStrength)
int	getCurrStrength ()
void	modifyFlatMax (String source, int value)
void	modifyPercentMax (String source, float percent)
void	unmodifyMax ()
void	removeDeployed (FighterWingAPI wing, boolean retreated)

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 17 of file CombatFleetManagerAPI.java.

Member Function Documentation

addToReserves()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.addToReserves

(

FleetMemberAPI

member

)

canEnemyDisengageCleanly()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.canEnemyDisengageCleanly

(

)

createWaypoint()

AssignmentTargetAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.createWaypoint	(	Vector2f	location,
		boolean	ally )

getAdmiralAI()

AdmiralAIPlugin com.fs.starfarer.api.combat.CombatFleetManagerAPI.getAdmiralAI

(

)

getAllEverDeployedCopy()

List< DeployedFleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getAllEverDeployedCopy

(

)

getAllFleetCommanders()

List< PersonAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getAllFleetCommanders

(

)

getBiggestStationDeployedOrNot()

FleetMemberAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getBiggestStationDeployedOrNot

(

)

getCurrStrength()

int com.fs.starfarer.api.combat.CombatFleetManagerAPI.getCurrStrength

(

)

getDefaultCommander()

PersonAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDefaultCommander

(

)

getDeployedCopy()

List< FleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeployedCopy

(

)

getDeployedCopyDFM()

List< DeployedFleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeployedCopyDFM

(

)

getDeployedFleetMember()

DeployedFleetMemberAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeployedFleetMember

(

ShipAPI

ship

)

getDeployedFleetMemberEvenIfDisabled()

DeployedFleetMemberAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeployedFleetMemberEvenIfDisabled

(

ShipAPI

ship

)

getDeployedFleetMemberFromAllEverDeployed()

DeployedFleetMemberAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeployedFleetMemberFromAllEverDeployed

(

ShipAPI

ship

)

getDeploymentYOffset()

float com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDeploymentYOffset

(

)

getDestroyedCopy()

List< FleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDestroyedCopy

(

)

getDisabledCopy()

List< FleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getDisabledCopy

(

)

getEnemyCleanDisengagePoints()

float com.fs.starfarer.api.combat.CombatFleetManagerAPI.getEnemyCleanDisengagePoints

(

)

getEnemyCleanDisengageProgress()

float com.fs.starfarer.api.combat.CombatFleetManagerAPI.getEnemyCleanDisengageProgress

(

)

getEnemyCleanDisengageThreshold()

float com.fs.starfarer.api.combat.CombatFleetManagerAPI.getEnemyCleanDisengageThreshold

(

)

getFleetCommander()

PersonAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getFleetCommander

(

)

May return null if both the reserves and the deployed lists are empty.

Returns

getFleetCommanderPreferPlayer()

PersonAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getFleetCommanderPreferPlayer

(

)

getGoal()

FleetGoal com.fs.starfarer.api.combat.CombatFleetManagerAPI.getGoal

(

)

getMaxStrength()

int com.fs.starfarer.api.combat.CombatFleetManagerAPI.getMaxStrength

(

)

Max deployment points available.

Returns

getOwner()

int com.fs.starfarer.api.combat.CombatFleetManagerAPI.getOwner

(

)

getReservesCopy()

List< FleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getReservesCopy

(

)

getRetreatedCopy()

List< FleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getRetreatedCopy

(

)

getShardToOriginalShipMap()

Map< DeployedFleetMemberAPI, DeployedFleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getShardToOriginalShipMap

(

)

getShipFor() [1/2]

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getShipFor

(

FleetMemberAPI

fleetMember

)

Returns ship that corresponds to the fleet member passed in. Returns the wing leader for fighter wings.

Parameters

fleetMember

Returns

getShipFor() [2/2]

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getShipFor

(

PersonAPI

captain

)

getStations()

List< DeployedFleetMemberAPI > com.fs.starfarer.api.combat.CombatFleetManagerAPI.getStations

(

)

getTaskManager()

CombatTaskManagerAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.getTaskManager

(

boolean

ally

)

isCanForceShipsToEngageWhenBattleClearlyLost()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.isCanForceShipsToEngageWhenBattleClearlyLost

(

)

isDefendingStation()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.isDefendingStation

(

)

isDeployedStation()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.isDeployedStation

(

)

isOnlyTimidOrNonCombatDeployed()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.isOnlyTimidOrNonCombatDeployed

(

)

isSuppressDeploymentMessages()

boolean com.fs.starfarer.api.combat.CombatFleetManagerAPI.isSuppressDeploymentMessages

(

)

modifyFlatMax()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.modifyFlatMax	(	String	source,
		int	value )

modifyPercentMax()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.modifyPercentMax	(	String	source,
		float	percent )

removeDeployed() [1/2]

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.removeDeployed	(	FighterWingAPI	wing,
		boolean	retreated )

removeDeployed() [2/2]

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.removeDeployed	(	ShipAPI	ship,
		boolean	retreated )

removeFromReserves()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.removeFromReserves

(

FleetMemberAPI

member

)

setAdmiralAI()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setAdmiralAI

(

AdmiralAIPlugin

admiralAI

)

setCanForceShipsToEngageWhenBattleClearlyLost()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setCanForceShipsToEngageWhenBattleClearlyLost

(

boolean

canForceShipsToEngageWhenBattleClearlyLost

)

Defaults to true for enemy, false for player side.

Parameters

canForceShipsToEngageWhenBattleClearlyLost

setDefaultCommander()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setDefaultCommander

(

PersonAPI

defaultCommander

)

setDeployedStation()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setDeployedStation

(

boolean

deployedStation

)

setDeploymentYOffset()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setDeploymentYOffset

(

float

deploymentYOffset

)

setMaxStrength()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setMaxStrength

(

int

maxStrength

)

setSuppressDeploymentMessages()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.setSuppressDeploymentMessages

(

boolean

suppressDeploymentMessages

)

spawnFleetMember()

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.spawnFleetMember	(	FleetMemberAPI	member,
		Vector2f	location,
		float	facing,
		float	initialBurnDur )

member does not actually have to be in the reserves.

Parameters

member
location
facing
initialBurnDur

Returns

spawnShipOrWing() [1/3]

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.spawnShipOrWing	(	String	specId,
		Vector2f	location,
		float	facing )

Deploy a ship/fighter wing with the given spec or variant id.

If there isn't one in the reserves, a temporary FleetMemberAPI is created and added to the reserves (but not the underlying CampaignFleetAPI, if any)

Parameters

id
location	Where to deploy.
facing	Facing at time of deployment.

Returns

spawnShipOrWing() [2/3]

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.spawnShipOrWing	(	String	specId,
		Vector2f	location,
		float	facing,
		float	initialBurnDur )

Deploy a ship/fighter wing with the given spec or variant id.

If there isn't one in the reserves, a temporary FleetMemberAPI is created and added to the reserves (but not the underlying CampaignFleetAPI, if any)

Parameters

specId
location
facing
level	crew experience level
initialBurnDur	amount of time travel drive should be on (in seconds)

Returns

spawnShipOrWing() [3/3]

ShipAPI com.fs.starfarer.api.combat.CombatFleetManagerAPI.spawnShipOrWing	(	String	specId,
		Vector2f	location,
		float	facing,
		float	initialBurnDur,
		PersonAPI	captain )

unmodifyMax()

void com.fs.starfarer.api.combat.CombatFleetManagerAPI.unmodifyMax

(

)

---

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

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