FleetMemberAPI

All Superinterfaces:: WithSourceMod

public interface FleetMemberAPI
extends WithSourceMod

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canBeDeployedForCombat()`
`boolean`	`canBeRepaired()`
`float`	`getBaseBuyValue()` In credits.
`float`	`getBaseDeployCost()`
`float`	`getBaseDeploymentCostSupplies()`
`float`	`getBaseSellValue()` In credits.
`float`	`getBaseValue()` Base value of hull and all mounted non-built-in weapons and fighter LPCs.
`BuffManagerAPI`	`getBuffManager()`
`PersonAPI`	`getCaptain()`
`float`	`getCargoCapacity()`
`CrewCompositionAPI`	`getCrewComposition()`
`float`	`getCrewFraction()` Fraction of crew on the ship, 0 to 1, ignores levels of crew.
`float`	`getDeployCost()` From 0 to 1, CR fraction.
`float`	`getDeploymentCostSupplies()`
`float`	`getDeploymentPointsCost()`
`PersonAPI`	`getFleetCommander()`
`PersonAPI`	`getFleetCommanderForStats()`
`FleetDataAPI`	`getFleetData()`
`FleetDataAPI`	`getFleetDataForStats()`
`int`	`getFleetPointCost()`
`float`	`getFuelCapacity()`
`float`	`getFuelUse()`
`java.lang.String`	`getHullId()`
`ShipHullSpecAPI`	`getHullSpec()`
`java.lang.String`	`getId()` Unique id, generated using Misc.genUID().
`float`	`getMaxCrew()`
`float`	`getMemberStrength()` Based on fleet points, modified by CR and ordnance points actually used by the variant.
`float`	`getMinCrew()`
`float`	`getNeededCrew()`
`int`	`getNumFightersInWing()`
`int`	`getNumFlightDecks()`
`org.lwjgl.util.vector.Vector2f`	`getOverrideSpriteSize()`
`int`	`getOwner()`
`java.lang.String`	`getPersonalityOverride()`
`RepairTrackerAPI`	`getRepairTracker()`
`int`	`getReplacementChassisCount()`
`java.lang.String`	`getShipName()`
`java.lang.String`	`getSpecId()`
`java.lang.String`	`getSpriteOverride()`
`MutableShipStatsAPI`	`getStats()`
`FleetMemberStatusAPI`	`getStatus()`
`FleetMemberType`	`getType()`
`float`	`getUnmodifiedDeploymentPointsCost()`
`ShipVariantAPI`	`getVariant()`
`boolean`	`isAlly()` True for non-player-controlled ships on the player's side in combat.
`boolean`	`isCapital()`
`boolean`	`isCarrier()`
`boolean`	`isCivilian()`
`boolean`	`isCruiser()`
`boolean`	`isDestroyer()`
`boolean`	`isFighterWing()`
`boolean`	`isFlagship()`
`boolean`	`isFrigate()`
`boolean`	`isMothballed()`
`boolean`	`isPhaseShip()`
`boolean`	`isStation()`
`boolean`	`needsRepairs()`
`void`	`setAlly(boolean isAlly)` True for non-player-controlled ships on the player's side in combat.
`void`	`setCaptain(PersonAPI commander)`
`void`	`setFlagship(boolean isFlagship)`
`void`	`setFlagship(boolean isFlagship, boolean withCaptainSet)`
`void`	`setFleetCommanderForStats(PersonAPI alternateFleetCommander, FleetDataAPI fleetForStats)`
`void`	`setId(java.lang.String id)`
`void`	`setOverrideSpriteSize(org.lwjgl.util.vector.Vector2f overrideSpriteSize)`
`void`	`setOwner(int owner)`
`void`	`setPersonalityOverride(java.lang.String personalityOverride)`
`void`	`setShipName(java.lang.String name)`
`void`	`setSpriteOverride(java.lang.String spriteOverride)` Sprite to use in the campaign view.
`void`	`setStatUpdateNeeded(boolean statUpdateNeeded)` Probably not needed given the current state of the API.
`void`	`setVariant(ShipVariantAPI variant, boolean withRefit, boolean withStatsUpdate)`
`void`	`updateStats()`

Methods inherited from interface com.fs.starfarer.api.loading.WithSourceMod
getSourceMod

Method Detail

getCaptain
```
PersonAPI getCaptain()
```

getStats
```
MutableShipStatsAPI getStats()
```

getShipName
```
java.lang.String getShipName()
```

setShipName

void setShipName(java.lang.String name)

getId
```
java.lang.String getId()
```
Unique id, generated using Misc.genUID().

Returns:

getSpecId
```
java.lang.String getSpecId()
```

getHullId
```
java.lang.String getHullId()
```

getType
```
FleetMemberType getType()
```

isFlagship
```
boolean isFlagship()
```

getNumFlightDecks
```
int getNumFlightDecks()
```

isCarrier
```
boolean isCarrier()
```

isCivilian
```
boolean isCivilian()
```

setFlagship
```
void setFlagship(boolean isFlagship)
```

getFleetPointCost
```
int getFleetPointCost()
```

isFighterWing
```
boolean isFighterWing()
```

isFrigate
```
boolean isFrigate()
```

isDestroyer
```
boolean isDestroyer()
```

isCruiser
```
boolean isCruiser()
```

isCapital
```
boolean isCapital()
```

getNumFightersInWing
```
int getNumFightersInWing()
```

getFuelCapacity
```
float getFuelCapacity()
```

getCargoCapacity
```
float getCargoCapacity()
```

getMinCrew
```
float getMinCrew()
```

getNeededCrew
```
float getNeededCrew()
```

getMaxCrew
```
float getMaxCrew()
```

getFuelUse
```
float getFuelUse()
```

getRepairTracker
```
RepairTrackerAPI getRepairTracker()
```

getHullSpec
```
ShipHullSpecAPI getHullSpec()
```

getFleetCommander
```
PersonAPI getFleetCommander()
```

canBeDeployedForCombat
```
boolean canBeDeployedForCombat()
```

getVariant
```
ShipVariantAPI getVariant()
```

getFleetData
```
FleetDataAPI getFleetData()
```

setVariant

void setVariant(ShipVariantAPI variant,
                boolean withRefit,
                boolean withStatsUpdate)

getCrewComposition

CrewCompositionAPI getCrewComposition()

getStatus
```
FleetMemberStatusAPI getStatus()
```

getCrewFraction
```
float getCrewFraction()
```
Fraction of crew on the ship, 0 to 1, ignores levels of crew.

Returns:

getReplacementChassisCount
```
int getReplacementChassisCount()
```

setStatUpdateNeeded
```
void setStatUpdateNeeded(boolean statUpdateNeeded)
```
Probably not needed given the current state of the API.

Parameters:

statUpdateNeeded -

getBuffManager
```
BuffManagerAPI getBuffManager()
```

isMothballed
```
boolean isMothballed()
```

getDeployCost
```
float getDeployCost()
```
From 0 to 1, CR fraction. Multiplied by number of fighters if fighter wing.

Returns:

setCaptain
```
void setCaptain(PersonAPI commander)
```

getMemberStrength
```
float 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:

getOwner
```
int getOwner()
```

setOwner
```
void setOwner(int owner)
```

getBaseSellValue
```
float getBaseSellValue()
```
In credits. Includes properly-adjusted cost of mounted weapons. Does not include any tariffs.

Returns:

getBaseBuyValue
```
float getBaseBuyValue()
```
In credits. Includes properly-adjusted cost of mounted weapons. Does not include any tariffs.

Returns:

needsRepairs
```
boolean needsRepairs()
```

canBeRepaired
```
boolean canBeRepaired()
```

getDeploymentPointsCost
```
float getDeploymentPointsCost()
```

getDeploymentCostSupplies
```
float getDeploymentCostSupplies()
```

getBaseDeployCost
```
float getBaseDeployCost()
```

isAlly
```
boolean isAlly()
```
True for non-player-controlled ships on the player's side in combat. Transient, not saved.

Returns:

setAlly
```
void setAlly(boolean isAlly)
```
True for non-player-controlled ships on the player's side in combat. Transient, not saved.

setFleetCommanderForStats

void setFleetCommanderForStats(PersonAPI alternateFleetCommander,
                               FleetDataAPI fleetForStats)

getFleetDataForStats
```
FleetDataAPI getFleetDataForStats()
```

getFleetCommanderForStats
```
PersonAPI getFleetCommanderForStats()
```

updateStats
```
void updateStats()
```

isStation
```
boolean isStation()
```

getBaseDeploymentCostSupplies
```
float getBaseDeploymentCostSupplies()
```

getBaseValue
```
float getBaseValue()
```
Base value of hull and all mounted non-built-in weapons and fighter LPCs.

Returns:

setSpriteOverride
```
void setSpriteOverride(java.lang.String spriteOverride)
```
Sprite to use in the campaign view. Currently used by custom stations.

Parameters:

spriteOverride -

getSpriteOverride
```
java.lang.String getSpriteOverride()
```

getOverrideSpriteSize

org.lwjgl.util.vector.Vector2f getOverrideSpriteSize()

setOverrideSpriteSize

void setOverrideSpriteSize(org.lwjgl.util.vector.Vector2f overrideSpriteSize)

isPhaseShip
```
boolean isPhaseShip()
```

setId
```
void setId(java.lang.String id)
```

getUnmodifiedDeploymentPointsCost

float getUnmodifiedDeploymentPointsCost()

setFlagship

void setFlagship(boolean isFlagship,
                 boolean withCaptainSet)

getPersonalityOverride

java.lang.String getPersonalityOverride()

setPersonalityOverride

void setPersonalityOverride(java.lang.String personalityOverride)

Interface FleetMemberAPI

Method Summary

Methods inherited from interface com.fs.starfarer.api.loading.WithSourceMod

Method Detail

getCaptain

getStats

getShipName

setShipName

getId

getSpecId

getHullId

getType

isFlagship

getNumFlightDecks

isCarrier

isCivilian

setFlagship

getFleetPointCost

isFighterWing

isFrigate

isDestroyer

isCruiser

isCapital

getNumFightersInWing

getFuelCapacity

getCargoCapacity

getMinCrew

getNeededCrew

getMaxCrew

getFuelUse

getRepairTracker

getHullSpec

getFleetCommander

canBeDeployedForCombat

getVariant

getFleetData

setVariant

getCrewComposition

getStatus

getCrewFraction

getReplacementChassisCount

setStatUpdateNeeded

getBuffManager

isMothballed

getDeployCost

setCaptain

getMemberStrength

getOwner

setOwner

getBaseSellValue

getBaseBuyValue

needsRepairs

canBeRepaired

getDeploymentPointsCost

getDeploymentCostSupplies

getBaseDeployCost

isAlly

setAlly

setFleetCommanderForStats

getFleetDataForStats

getFleetCommanderForStats

updateStats

isStation

getBaseDeploymentCostSupplies

getBaseValue

setSpriteOverride

getSpriteOverride

getOverrideSpriteSize

setOverrideSpriteSize

isPhaseShip

setId

getUnmodifiedDeploymentPointsCost

setFlagship

getPersonalityOverride

setPersonalityOverride