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

Inheritance diagram for com.fs.starfarer.api.combat.ShipHullSpecAPI:

Collaboration diagram for com.fs.starfarer.api.combat.ShipHullSpecAPI:

Classes
interface	EngineSpecAPI
interface	ShieldSpecAPI
enum	ShipTypeHints

Public Member Functions
ShieldSpecAPI	getShieldSpec ()
ShieldType	getDefenseType ()
String	getHullId ()
String	getHullName ()
EnumSet< ShipTypeHints >	getHints ()
float	getNoCRLossTime ()
float	getCRToDeploy ()
float	getCRLossPerSecond ()
float	getCRLossPerSecond (MutableShipStatsAPI stats)
float	getBaseValue ()
int	getOrdnancePoints (MutableCharacterStatsAPI stats)
HullSize	getHullSize ()
float	getHitpoints ()
float	getArmorRating ()
float	getFluxCapacity ()
float	getFluxDissipation ()
ShieldType	getShieldType ()
List< WeaponSlotAPI >	getAllWeaponSlotsCopy ()
String	getSpriteName ()
boolean	isCompatibleWithBase ()
String	getBaseHullId ()
float	getBaseShieldFluxPerDamageAbsorbed ()
String	getHullNameWithDashClass ()
boolean	hasHullName ()
float	getBreakProb ()
float	getMinPieces ()
float	getMaxPieces ()
int	getFighterBays ()
float	getMinCrew ()
float	getMaxCrew ()
float	getCargo ()
float	getFuel ()
float	getFuelPerLY ()
boolean	isDHull ()
boolean	isDefaultDHull ()
void	setDParentHullId (String dParentHullId)
String	getDParentHullId ()
ShipHullSpecAPI	getDParentHull ()
ShipHullSpecAPI	getBaseHull ()
List< String >	getBuiltInWings ()
boolean	isBuiltInWing (int index)
String	getDesignation ()
boolean	hasDesignation ()
boolean	isRestoreToBase ()
void	setRestoreToBase (boolean restoreToBase)
Vector2f	getModuleAnchor ()
void	setModuleAnchor (Vector2f moduleAnchor)
void	setCompatibleWithBase (boolean compatibleWithBase)
Set< String >	getTags ()
void	addTag (String tag)
boolean	hasTag (String tag)
float	getRarity ()
String	getNameWithDesignationWithDashClass ()
String	getDescriptionId ()
boolean	isBaseHull ()
void	setManufacturer (String manufacturer)
String	getManufacturer ()
int	getFleetPoints ()
List< String >	getBuiltInMods ()
WeaponSlotAPI	getWeaponSlotAPI (String slotId)
String	getDescriptionPrefix ()
boolean	isBuiltInMod (String modId)
void	addBuiltInMod (String modId)
boolean	isCivilianNonCarrier ()
void	setHullName (String hullName)
void	setDesignation (String designation)
boolean	isPhase ()
String	getShipFilePath ()
String	getTravelDriveId ()
void	setTravelDriveId (String travelDriveId)
EngineSpecAPI	getEngineSpec ()
float	getSuppliesToRecover ()
void	setSuppliesToRecover (float suppliesToRecover)
float	getSuppliesPerMonth ()
void	setSuppliesPerMonth (float suppliesPerMonth)
void	setRepairPercentPerDay (float repairPercentPerDay)
void	setCRToDeploy (float crToDeploy)
float	getNoCRLossSeconds ()
void	setNoCRLossSeconds (float noCRLossSeconds)
void	setCRLossPerSecond (float crLossPerSecond)
HashMap< String, String >	getBuiltInWeapons ()
boolean	isBuiltIn (String slotId)
void	addBuiltInWeapon (String slotId, String weaponId)
String	getShipDefenseId ()
void	setShipDefenseId (String shipDefenseId)
String	getShipSystemId ()
void	setShipSystemId (String shipSystemId)
void	setDescriptionPrefix (String descriptionPrefix)
WeaponSlotAPI	getWeaponSlot (String slotId)
void	setFleetPoints (int fleetPoints)
void	setDescriptionId (String descriptionId)
Color	getHyperspaceJitterColor ()
boolean	isDHullOldMethod ()
boolean	isCarrier ()
String	getLogisticsNAReason ()
void	setLogisticsNAReason (String logisticsNAReason)
float	getCollisionRadius ()
String	getCodexVariantId ()
void	setCodexVariantId (String codexVariantId)
String	getRestoredToHullId ()
Public Member Functions inherited from com.fs.starfarer.api.loading.WithSourceMod
ModSpecAPI	getSourceMod ()

Detailed Description

Definition at line 18 of file ShipHullSpecAPI.java.

Member Function Documentation

addBuiltInMod()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.addBuiltInMod

(

String

modId

)

addBuiltInWeapon()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.addBuiltInWeapon	(	String	slotId,
		String	weaponId )

addTag()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.addTag

(

String

tag

)

getAllWeaponSlotsCopy()

List< WeaponSlotAPI > com.fs.starfarer.api.combat.ShipHullSpecAPI.getAllWeaponSlotsCopy

(

)

getArmorRating()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getArmorRating

(

)

getBaseHull()

ShipHullSpecAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getBaseHull

(

)

getBaseHullId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getBaseHullId

(

)

getBaseShieldFluxPerDamageAbsorbed()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getBaseShieldFluxPerDamageAbsorbed

(

)

getBaseValue()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getBaseValue

(

)

getBreakProb()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getBreakProb

(

)

getBuiltInMods()

List< String > com.fs.starfarer.api.combat.ShipHullSpecAPI.getBuiltInMods

(

)

getBuiltInWeapons()

HashMap< String, String > com.fs.starfarer.api.combat.ShipHullSpecAPI.getBuiltInWeapons

(

)

getBuiltInWings()

List< String > com.fs.starfarer.api.combat.ShipHullSpecAPI.getBuiltInWings

(

)

getCargo()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getCargo

(

)

getCodexVariantId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getCodexVariantId

(

)

getCollisionRadius()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getCollisionRadius

(

)

getCRLossPerSecond() [1/2]

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getCRLossPerSecond

(

)

getCRLossPerSecond() [2/2]

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getCRLossPerSecond

(

MutableShipStatsAPI

stats

)

The returned value is NOT modified by stats.getCRLossPerSecondPercent(), but does account for modifications to stats.getCRPerDeploymentPercent().

Parameters

stats

Returns

(Equivalent to getCRLossPerSecond(), the parameter is ignored.)

Parameters

stats

Returns

getCRToDeploy()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getCRToDeploy

(

)

getDefenseType()

ShieldType com.fs.starfarer.api.combat.ShipHullSpecAPI.getDefenseType

(

)

getDescriptionId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getDescriptionId

(

)

getDescriptionPrefix()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getDescriptionPrefix

(

)

getDesignation()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getDesignation

(

)

getDParentHull()

ShipHullSpecAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getDParentHull

(

)

getDParentHullId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getDParentHullId

(

)

getEngineSpec()

EngineSpecAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getEngineSpec

(

)

getFighterBays()

int com.fs.starfarer.api.combat.ShipHullSpecAPI.getFighterBays

(

)

getFleetPoints()

int com.fs.starfarer.api.combat.ShipHullSpecAPI.getFleetPoints

(

)

getFluxCapacity()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getFluxCapacity

(

)

getFluxDissipation()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getFluxDissipation

(

)

getFuel()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getFuel

(

)

getFuelPerLY()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getFuelPerLY

(

)

getHints()

EnumSet< ShipTypeHints > com.fs.starfarer.api.combat.ShipHullSpecAPI.getHints

(

)

getHitpoints()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getHitpoints

(

)

getHullId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getHullId

(

)

getHullName()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getHullName

(

)

getHullNameWithDashClass()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getHullNameWithDashClass

(

)

getHullSize()

HullSize com.fs.starfarer.api.combat.ShipHullSpecAPI.getHullSize

(

)

getHyperspaceJitterColor()

Color com.fs.starfarer.api.combat.ShipHullSpecAPI.getHyperspaceJitterColor

(

)

getLogisticsNAReason()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getLogisticsNAReason

(

)

getManufacturer()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getManufacturer

(

)

getMaxCrew()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getMaxCrew

(

)

getMaxPieces()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getMaxPieces

(

)

getMinCrew()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getMinCrew

(

)

getMinPieces()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getMinPieces

(

)

getModuleAnchor()

Vector2f com.fs.starfarer.api.combat.ShipHullSpecAPI.getModuleAnchor

(

)

getNameWithDesignationWithDashClass()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getNameWithDesignationWithDashClass

(

)

getNoCRLossSeconds()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getNoCRLossSeconds

(

)

getNoCRLossTime()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getNoCRLossTime

(

)

getOrdnancePoints()

int com.fs.starfarer.api.combat.ShipHullSpecAPI.getOrdnancePoints

(

MutableCharacterStatsAPI

stats

)

getRarity()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getRarity

(

)

getRestoredToHullId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getRestoredToHullId

(

)

getShieldSpec()

ShieldSpecAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getShieldSpec

(

)

getShieldType()

ShieldType com.fs.starfarer.api.combat.ShipHullSpecAPI.getShieldType

(

)

getShipDefenseId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getShipDefenseId

(

)

getShipFilePath()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getShipFilePath

(

)

getShipSystemId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getShipSystemId

(

)

getSpriteName()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getSpriteName

(

)

getSuppliesPerMonth()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getSuppliesPerMonth

(

)

getSuppliesToRecover()

float com.fs.starfarer.api.combat.ShipHullSpecAPI.getSuppliesToRecover

(

)

getTags()

Set< String > com.fs.starfarer.api.combat.ShipHullSpecAPI.getTags

(

)

getTravelDriveId()

String com.fs.starfarer.api.combat.ShipHullSpecAPI.getTravelDriveId

(

)

getWeaponSlot()

WeaponSlotAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getWeaponSlot

(

String

slotId

)

getWeaponSlotAPI()

WeaponSlotAPI com.fs.starfarer.api.combat.ShipHullSpecAPI.getWeaponSlotAPI

(

String

slotId

)

hasDesignation()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.hasDesignation

(

)

hasHullName()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.hasHullName

(

)

hasTag()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.hasTag

(

String

tag

)

isBaseHull()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isBaseHull

(

)

isBuiltIn()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isBuiltIn

(

String

slotId

)

isBuiltInMod()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isBuiltInMod

(

String

modId

)

isBuiltInWing()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isBuiltInWing

(

int

index

)

isCarrier()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isCarrier

(

)

isCivilianNonCarrier()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isCivilianNonCarrier

(

)

isCompatibleWithBase()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isCompatibleWithBase

(

)

isDefaultDHull()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isDefaultDHull

(

)

isDHull()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isDHull

(

)

isDHullOldMethod()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isDHullOldMethod

(

)

isPhase()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isPhase

(

)

isRestoreToBase()

boolean com.fs.starfarer.api.combat.ShipHullSpecAPI.isRestoreToBase

(

)

setCodexVariantId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setCodexVariantId

(

String

codexVariantId

)

setCompatibleWithBase()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setCompatibleWithBase

(

boolean

compatibleWithBase

)

setCRLossPerSecond()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setCRLossPerSecond

(

float

crLossPerSecond

)

setCRToDeploy()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setCRToDeploy

(

float

crToDeploy

)

setDescriptionId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setDescriptionId

(

String

descriptionId

)

setDescriptionPrefix()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setDescriptionPrefix

(

String

descriptionPrefix

)

setDesignation()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setDesignation

(

String

designation

)

setDParentHullId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setDParentHullId

(

String

dParentHullId

)

setFleetPoints()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setFleetPoints

(

int

fleetPoints

)

setHullName()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setHullName

(

String

hullName

)

setLogisticsNAReason()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setLogisticsNAReason

(

String

logisticsNAReason

)

setManufacturer()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setManufacturer

(

String

manufacturer

)

setModuleAnchor()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setModuleAnchor

(

Vector2f

moduleAnchor

)

setNoCRLossSeconds()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setNoCRLossSeconds

(

float

noCRLossSeconds

)

setRepairPercentPerDay()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setRepairPercentPerDay

(

float

repairPercentPerDay

)

setRestoreToBase()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setRestoreToBase

(

boolean

restoreToBase

)

setShipDefenseId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setShipDefenseId

(

String

shipDefenseId

)

setShipSystemId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setShipSystemId

(

String

shipSystemId

)

setSuppliesPerMonth()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setSuppliesPerMonth

(

float

suppliesPerMonth

)

setSuppliesToRecover()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setSuppliesToRecover

(

float

suppliesToRecover

)

setTravelDriveId()

void com.fs.starfarer.api.combat.ShipHullSpecAPI.setTravelDriveId

(

String

travelDriveId

)

---

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

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