com.fs.starfarer.api.fleet.FleetMemberAPI Interface Reference

Inheritance diagram for com.fs.starfarer.api.fleet.FleetMemberAPI:

Collaboration diagram for com.fs.starfarer.api.fleet.FleetMemberAPI:

Public Member Functions
PersonAPI	getCaptain ()
MutableShipStatsAPI	getStats ()
String	getShipName ()
void	setShipName (String name)
String	getId ()
String	getSpecId ()
String	getHullId ()
FleetMemberType	getType ()
boolean	isFlagship ()
int	getNumFlightDecks ()
boolean	isCarrier ()
boolean	isCivilian ()
void	setFlagship (boolean isFlagship)
int	getFleetPointCost ()
boolean	isFighterWing ()
boolean	isFrigate ()
boolean	isDestroyer ()
boolean	isCruiser ()
boolean	isCapital ()
int	getNumFightersInWing ()
float	getFuelCapacity ()
float	getCargoCapacity ()
float	getMinCrew ()
float	getNeededCrew ()
float	getMaxCrew ()
float	getFuelUse ()
RepairTrackerAPI	getRepairTracker ()
ShipHullSpecAPI	getHullSpec ()
PersonAPI	getFleetCommander ()
boolean	canBeDeployedForCombat ()
ShipVariantAPI	getVariant ()
FleetDataAPI	getFleetData ()
void	setVariant (ShipVariantAPI variant, boolean withRefit, boolean withStatsUpdate)
CrewCompositionAPI	getCrewComposition ()
FleetMemberStatusAPI	getStatus ()
float	getCrewFraction ()
int	getReplacementChassisCount ()
void	setStatUpdateNeeded (boolean statUpdateNeeded)
BuffManagerAPI	getBuffManager ()
boolean	isMothballed ()
float	getDeployCost ()
void	setCaptain (PersonAPI commander)
float	getMemberStrength ()
int	getOwner ()
void	setOwner (int owner)
float	getBaseSellValue ()
float	getBaseBuyValue ()
boolean	needsRepairs ()
boolean	canBeRepaired ()
float	getDeploymentPointsCost ()
float	getDeploymentCostSupplies ()
float	getBaseDeployCost ()
boolean	isAlly ()
void	setAlly (boolean isAlly)
void	setFleetCommanderForStats (PersonAPI alternateFleetCommander, FleetDataAPI fleetForStats)
FleetDataAPI	getFleetDataForStats ()
PersonAPI	getFleetCommanderForStats ()
void	updateStats ()
boolean	isStation ()
float	getBaseDeploymentCostSupplies ()
float	getBaseValue ()
void	setSpriteOverride (String spriteOverride)
String	getSpriteOverride ()
Vector2f	getOverrideSpriteSize ()
void	setOverrideSpriteSize (Vector2f overrideSpriteSize)
boolean	isPhaseShip ()
void	setId (String id)
float	getUnmodifiedDeploymentPointsCost ()
void	setFlagship (boolean isFlagship, boolean withCaptainSet)
String	getPersonalityOverride ()
void	setPersonalityOverride (String personalityOverride)
Public Member Functions inherited from com.fs.starfarer.api.loading.WithSourceMod
ModSpecAPI	getSourceMod ()

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 18 of file FleetMemberAPI.java.

Member Function Documentation

canBeDeployedForCombat()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.canBeDeployedForCombat

(

)

canBeRepaired()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.canBeRepaired

(

)

getBaseBuyValue()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getBaseBuyValue

(

)

In credits. Includes properly-adjusted cost of mounted weapons. Does not include any tariffs.

Returns

getBaseDeployCost()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getBaseDeployCost

(

)

getBaseDeploymentCostSupplies()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getBaseDeploymentCostSupplies

(

)

getBaseSellValue()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getBaseSellValue

(

)

In credits. Includes properly-adjusted cost of mounted weapons. Does not include any tariffs.

Returns

getBaseValue()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getBaseValue

(

)

Base value of hull and all mounted non-built-in weapons and fighter LPCs.

Returns

getBuffManager()

BuffManagerAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getBuffManager

(

)

getCaptain()

PersonAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getCaptain

(

)

getCargoCapacity()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getCargoCapacity

(

)

getCrewComposition()

CrewCompositionAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getCrewComposition

(

)

getCrewFraction()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getCrewFraction

(

)

Fraction of crew on the ship, 0 to 1, ignores levels of crew.

Returns

getDeployCost()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getDeployCost

(

)

From 0 to 1, CR fraction. Multiplied by number of fighters if fighter wing.

Returns

getDeploymentCostSupplies()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getDeploymentCostSupplies

(

)

getDeploymentPointsCost()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getDeploymentPointsCost

(

)

getFleetCommander()

PersonAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getFleetCommander

(

)

getFleetCommanderForStats()

PersonAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getFleetCommanderForStats

(

)

getFleetData()

FleetDataAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getFleetData

(

)

getFleetDataForStats()

FleetDataAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getFleetDataForStats

(

)

getFleetPointCost()

int com.fs.starfarer.api.fleet.FleetMemberAPI.getFleetPointCost

(

)

getFuelCapacity()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getFuelCapacity

(

)

getFuelUse()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getFuelUse

(

)

getHullId()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getHullId

(

)

getHullSpec()

ShipHullSpecAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getHullSpec

(

)

getId()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getId

(

)

Unique id, generated using Misc.genUID().

Returns

getMaxCrew()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getMaxCrew

(

)

getMemberStrength()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getMemberStrength

(

)

Based on fleet points, modified by CR and ordnance points actually used by the variant.

Not modified by hull status or captain quality.

Returns

getMinCrew()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getMinCrew

(

)

getNeededCrew()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getNeededCrew

(

)

getNumFightersInWing()

int com.fs.starfarer.api.fleet.FleetMemberAPI.getNumFightersInWing

(

)

getNumFlightDecks()

int com.fs.starfarer.api.fleet.FleetMemberAPI.getNumFlightDecks

(

)

getOverrideSpriteSize()

Vector2f com.fs.starfarer.api.fleet.FleetMemberAPI.getOverrideSpriteSize

(

)

getOwner()

int com.fs.starfarer.api.fleet.FleetMemberAPI.getOwner

(

)

getPersonalityOverride()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getPersonalityOverride

(

)

getRepairTracker()

RepairTrackerAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getRepairTracker

(

)

getReplacementChassisCount()

int com.fs.starfarer.api.fleet.FleetMemberAPI.getReplacementChassisCount

(

)

getShipName()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getShipName

(

)

getSpecId()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getSpecId

(

)

getSpriteOverride()

String com.fs.starfarer.api.fleet.FleetMemberAPI.getSpriteOverride

(

)

getStats()

MutableShipStatsAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getStats

(

)

getStatus()

FleetMemberStatusAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getStatus

(

)

getType()

FleetMemberType com.fs.starfarer.api.fleet.FleetMemberAPI.getType

(

)

getUnmodifiedDeploymentPointsCost()

float com.fs.starfarer.api.fleet.FleetMemberAPI.getUnmodifiedDeploymentPointsCost

(

)

getVariant()

ShipVariantAPI com.fs.starfarer.api.fleet.FleetMemberAPI.getVariant

(

)

isAlly()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isAlly

(

)

True for non-player-controlled ships on the player's side in combat. Transient, not saved.

Returns

isCapital()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isCapital

(

)

isCarrier()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isCarrier

(

)

isCivilian()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isCivilian

(

)

isCruiser()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isCruiser

(

)

isDestroyer()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isDestroyer

(

)

isFighterWing()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isFighterWing

(

)

isFlagship()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isFlagship

(

)

isFrigate()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isFrigate

(

)

isMothballed()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isMothballed

(

)

isPhaseShip()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isPhaseShip

(

)

isStation()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.isStation

(

)

needsRepairs()

boolean com.fs.starfarer.api.fleet.FleetMemberAPI.needsRepairs

(

)

setAlly()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setAlly

(

boolean

isAlly

)

True for non-player-controlled ships on the player's side in combat. Transient, not saved.

setCaptain()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setCaptain

(

PersonAPI

commander

)

setFlagship() [1/2]

void com.fs.starfarer.api.fleet.FleetMemberAPI.setFlagship

(

boolean

isFlagship

)

setFlagship() [2/2]

void com.fs.starfarer.api.fleet.FleetMemberAPI.setFlagship	(	boolean	isFlagship,
		boolean	withCaptainSet )

setFleetCommanderForStats()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setFleetCommanderForStats	(	PersonAPI	alternateFleetCommander,
		FleetDataAPI	fleetForStats )

setId()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setId

(

String

id

)

setOverrideSpriteSize()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setOverrideSpriteSize

(

Vector2f

overrideSpriteSize

)

setOwner()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setOwner

(

int

owner

)

setPersonalityOverride()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setPersonalityOverride

(

String

personalityOverride

)

setShipName()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setShipName

(

String

name

)

setSpriteOverride()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setSpriteOverride

(

String

spriteOverride

)

Sprite to use in the campaign view. Currently used by custom stations.

Parameters

spriteOverride

setStatUpdateNeeded()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setStatUpdateNeeded

(

boolean

statUpdateNeeded

)

Probably not needed given the current state of the API.

Parameters

statUpdateNeeded

setVariant()

void com.fs.starfarer.api.fleet.FleetMemberAPI.setVariant	(	ShipVariantAPI	variant,
		boolean	withRefit,
		boolean	withStatsUpdate )

updateStats()

void com.fs.starfarer.api.fleet.FleetMemberAPI.updateStats

(

)

---

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

• src/com/fs/starfarer/api/fleet/FleetMemberAPI.java