Starsector API
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
com.fs.starfarer.api.combat.BaseHullMod Class Reference

Inherits com.fs.starfarer.api.combat.HullModEffect.

Inherited by com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.AblativeArmor, com.fs.starfarer.api.impl.hullmods.AdaptivePhaseCoils, com.fs.starfarer.api.impl.hullmods.AdvancedGroundSupport, com.fs.starfarer.api.impl.hullmods.AndradaMods, com.fs.starfarer.api.impl.hullmods.AssaultPackage, com.fs.starfarer.api.impl.hullmods.Automated, com.fs.starfarer.api.impl.hullmods.BDeck, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BaseLogisticsHullMod, com.fs.starfarer.api.impl.hullmods.CompromisedStorage, com.fs.starfarer.api.impl.hullmods.CompromisedStructure, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.DamagedFlightDeck, com.fs.starfarer.api.impl.hullmods.DamagedWeaponMounts, com.fs.starfarer.api.impl.hullmods.DefectiveManufactory, com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.DegradedLifeSupport, com.fs.starfarer.api.impl.hullmods.DegradedShields, com.fs.starfarer.api.impl.hullmods.DesignCompromises, com.fs.starfarer.api.impl.hullmods.DistributedFireControl, com.fs.starfarer.api.impl.hullmods.DoNotBackOff, com.fs.starfarer.api.impl.hullmods.DriveFieldStabilizer, com.fs.starfarer.api.impl.hullmods.ECMPackage, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.ErraticInjector, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.ExpandedDeckCrew, com.fs.starfarer.api.impl.hullmods.ExperimentalPhaseCoils, com.fs.starfarer.api.impl.hullmods.FaultyAutomatedSystems, com.fs.starfarer.api.impl.hullmods.FighterChassisStorage, com.fs.starfarer.api.impl.hullmods.FlightControl, com.fs.starfarer.api.impl.hullmods.FragileSubsystems, com.fs.starfarer.api.impl.hullmods.GlitchedSensorArray, com.fs.starfarer.api.impl.hullmods.GroundSupport, com.fs.starfarer.api.impl.hullmods.HeavyBallisticsIntegration, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.IncreasedMaintenance, com.fs.starfarer.api.impl.hullmods.MalfunctioningComms, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NavRelay, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.OperationsCenter, com.fs.starfarer.api.impl.hullmods.PDIntegration, com.fs.starfarer.api.impl.hullmods.PeriodicMissileReload, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.PhaseField, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, com.fs.starfarer.api.impl.hullmods.RuggedConstruction, com.fs.starfarer.api.impl.hullmods.ShardSpawner, com.fs.starfarer.api.impl.hullmods.SharedFluxSink, com.fs.starfarer.api.impl.hullmods.ShieldAlwaysOn, com.fs.starfarer.api.impl.hullmods.ShieldShunt, com.fs.starfarer.api.impl.hullmods.StealthMinefield, and com.fs.starfarer.api.impl.hullmods.VastHangar.

Collaboration diagram for com.fs.starfarer.api.combat.BaseHullMod:
[legend]

Public Member Functions

void init (HullModSpecAPI spec)
 
boolean isSMod (MutableShipStatsAPI stats)
 
boolean isSMod (ShipAPI ship)
 
boolean isBuiltIn (ShipAPI ship)
 
void applyEffectsAfterShipCreation (ShipAPI ship, String id)
 
void applyEffectsBeforeShipCreation (HullSize hullSize, MutableShipStatsAPI stats, String id)
 
String getDescriptionParam (int index, HullSize hullSize)
 
String getDescriptionParam (int index, HullSize hullSize, ShipAPI ship)
 
String getSModDescriptionParam (int index, HullSize hullSize)
 
String getSModDescriptionParam (int index, HullSize hullSize, ShipAPI ship)
 
boolean isApplicableToShip (ShipAPI ship)
 
void advanceInCampaign (FleetMemberAPI member, float amount)
 
void advanceInCombat (ShipAPI ship, float amount)
 
String getUnapplicableReason (ShipAPI ship)
 
boolean affectsOPCosts ()
 
boolean canBeAddedOrRemovedNow (ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode)
 
String getCanNotBeInstalledNowReason (ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode)
 
boolean shouldAddDescriptionToTooltip (HullSize hullSize, ShipAPI ship, boolean isForModSpec)
 
void addPostDescriptionSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec)
 
boolean hasSModEffectSection (HullSize hullSize, ShipAPI ship, boolean isForModSpec)
 
boolean isSModEffectAPenalty ()
 
boolean hasSModEffect ()
 
void addSModEffectSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
 
void addSModSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
 
void applyEffectsToFighterSpawnedByShip (ShipAPI fighter, ShipAPI ship, String id)
 
boolean shipHasOtherModInCategory (ShipAPI ship, String currMod, String category)
 
boolean isInPlayerFleet (MutableShipStatsAPI stats)
 
boolean isInPlayerFleet (ShipAPI ship)
 
Color getBorderColor ()
 
Color getNameColor ()
 
int getDisplaySortOrder ()
 
int getDisplayCategoryIndex ()
 
float getTooltipWidth ()
 
boolean showInRefitScreenModPickerFor (ShipAPI ship)
 
void addRequiredItemSection (TooltipMakerAPI tooltip, FleetMemberAPI member, ShipVariantAPI currentVariant, MarketAPI dockedAt, float width, boolean isForModSpec)
 
- Public Member Functions inherited from com.fs.starfarer.api.combat.HullModEffect
default CargoStackAPI getRequiredItem ()
 
default void applyEffectsAfterShipAddedToCombatEngine (ShipAPI ship, String id)
 

Protected Attributes

HullModSpecAPI spec
 

Detailed Description

Definition at line 21 of file BaseHullMod.java.

Member Function Documentation

◆ addPostDescriptionSection()

void com.fs.starfarer.api.combat.BaseHullMod.addPostDescriptionSection ( TooltipMakerAPI tooltip,
HullSize hullSize,
ShipAPI ship,
float width,
boolean isForModSpec )

ship may be null, will be for modspecs. hullsize will always be CAPITAL_SHIP for modspecs.

Parameters
tooltip
hullSize
ship
width
isForModSpec

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.ShroudedLensHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedThunderheadHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.Automated, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.HighResSensors, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NeuralInterface, and com.fs.starfarer.api.impl.hullmods.PhaseField.

Definition at line 130 of file BaseHullMod.java.

◆ addRequiredItemSection()

void com.fs.starfarer.api.combat.BaseHullMod.addRequiredItemSection ( TooltipMakerAPI tooltip,
FleetMemberAPI member,
ShipVariantAPI currentVariant,
MarketAPI dockedAt,
float width,
boolean isForModSpec )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 328 of file BaseHullMod.java.

◆ addSModEffectSection()

void com.fs.starfarer.api.combat.BaseHullMod.addSModEffectSection ( TooltipMakerAPI tooltip,
HullSize hullSize,
ShipAPI ship,
float width,
boolean isForModSpec,
boolean isForBuildInList )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 156 of file BaseHullMod.java.

◆ addSModSection()

void com.fs.starfarer.api.combat.BaseHullMod.addSModSection ( TooltipMakerAPI tooltip,
HullSize hullSize,
ShipAPI ship,
float width,
boolean isForModSpec,
boolean isForBuildInList )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 175 of file BaseHullMod.java.

◆ advanceInCampaign()

void com.fs.starfarer.api.combat.BaseHullMod.advanceInCampaign ( FleetMemberAPI member,
float amount )

Not called while paused. But, called when the fleet data needs to be re-synced, with amount=0 (such as if, say, a fleet member is moved around. in the fleet screen.)

Parameters
member
amount

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 75 of file BaseHullMod.java.

◆ advanceInCombat()

void com.fs.starfarer.api.combat.BaseHullMod.advanceInCombat ( ShipAPI ship,
float amount )

Not called while paused.

Parameters
ship
amount

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedLensHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedMantleHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedThunderheadHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.BDeck, com.fs.starfarer.api.impl.hullmods.DoNotBackOff, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.OperationsCenter, com.fs.starfarer.api.impl.hullmods.PeriodicMissileReload, com.fs.starfarer.api.impl.hullmods.ShardSpawner, com.fs.starfarer.api.impl.hullmods.SharedFluxSink, com.fs.starfarer.api.impl.hullmods.ShieldAlwaysOn, and com.fs.starfarer.api.impl.hullmods.StealthMinefield.

Definition at line 79 of file BaseHullMod.java.

◆ affectsOPCosts()

boolean com.fs.starfarer.api.combat.BaseHullMod.affectsOPCosts ( )

Hullmods that return true here should only ever be built-in, as cost changes aren't handled when these mods can be added or removed to/from the variant.

Returns

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.HeavyBallisticsIntegration, com.fs.starfarer.api.impl.hullmods.PDIntegration, com.fs.starfarer.api.impl.hullmods.RuggedConstruction, and com.fs.starfarer.api.impl.hullmods.VastHangar.

Definition at line 87 of file BaseHullMod.java.

◆ applyEffectsAfterShipCreation()

void com.fs.starfarer.api.combat.BaseHullMod.applyEffectsAfterShipCreation ( ShipAPI ship,
String id )

Effects applied here should NOT affect ship stats as this does not get called from the campaign. Apply stat changes in applyEffectsBeforeShipCreation() instead, as that does affect the campaign.

Parameters
ship
id

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedThunderheadHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.Automated, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BDeck, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.PDIntegration, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.ShieldShunt, and com.fs.starfarer.api.impl.hullmods.TerminatorCore.

Definition at line 46 of file BaseHullMod.java.

◆ applyEffectsBeforeShipCreation()

void com.fs.starfarer.api.combat.BaseHullMod.applyEffectsBeforeShipCreation ( HullSize hullSize,
MutableShipStatsAPI stats,
String id )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod, com.fs.starfarer.api.impl.combat.dweller.HumanShipShroudedHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedMantleHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.AblativeArmor, com.fs.starfarer.api.impl.hullmods.AdaptivePhaseCoils, com.fs.starfarer.api.impl.hullmods.AdditionalBerthing, com.fs.starfarer.api.impl.hullmods.AdvancedGroundSupport, com.fs.starfarer.api.impl.hullmods.AndradaMods, com.fs.starfarer.api.impl.hullmods.AssaultPackage, com.fs.starfarer.api.impl.hullmods.Automated, com.fs.starfarer.api.impl.hullmods.AuxiliaryFuelTanks, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BDeck, com.fs.starfarer.api.impl.hullmods.CompromisedStorage, com.fs.starfarer.api.impl.hullmods.CompromisedStructure, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.DamagedFlightDeck, com.fs.starfarer.api.impl.hullmods.DamagedWeaponMounts, com.fs.starfarer.api.impl.hullmods.DefectiveManufactory, com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.DegradedLifeSupport, com.fs.starfarer.api.impl.hullmods.DegradedShields, com.fs.starfarer.api.impl.hullmods.DesignCompromises, com.fs.starfarer.api.impl.hullmods.DistributedFireControl, com.fs.starfarer.api.impl.hullmods.DriveFieldStabilizer, com.fs.starfarer.api.impl.hullmods.ECMPackage, com.fs.starfarer.api.impl.hullmods.EfficiencyOverhaul, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.ErraticInjector, com.fs.starfarer.api.impl.hullmods.ExpandedCargoHolds, com.fs.starfarer.api.impl.hullmods.ExpandedDeckCrew, com.fs.starfarer.api.impl.hullmods.ExperimentalPhaseCoils, com.fs.starfarer.api.impl.hullmods.FaultyAutomatedSystems, com.fs.starfarer.api.impl.hullmods.FighterChassisStorage, com.fs.starfarer.api.impl.hullmods.FragileSubsystems, com.fs.starfarer.api.impl.hullmods.GlitchedSensorArray, com.fs.starfarer.api.impl.hullmods.GroundSupport, com.fs.starfarer.api.impl.hullmods.HeavyBallisticsIntegration, com.fs.starfarer.api.impl.hullmods.HighEfficiencyDriveField, com.fs.starfarer.api.impl.hullmods.HighResSensors, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.IncreasedMaintenance, com.fs.starfarer.api.impl.hullmods.MalfunctioningComms, com.fs.starfarer.api.impl.hullmods.MilitarizedSubsystems, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NavRelay, com.fs.starfarer.api.impl.hullmods.NeuralIntegrator, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.OperationsCenter, com.fs.starfarer.api.impl.hullmods.PDIntegration, com.fs.starfarer.api.impl.hullmods.PeriodicMissileReload, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.PhaseField, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, com.fs.starfarer.api.impl.hullmods.RuggedConstruction, com.fs.starfarer.api.impl.hullmods.ShardSpawner, com.fs.starfarer.api.impl.hullmods.ShieldAlwaysOn, com.fs.starfarer.api.impl.hullmods.ShieldShunt, com.fs.starfarer.api.impl.hullmods.TerminatorCore, and com.fs.starfarer.api.impl.hullmods.VastHangar.

Definition at line 49 of file BaseHullMod.java.

◆ applyEffectsToFighterSpawnedByShip()

void com.fs.starfarer.api.combat.BaseHullMod.applyEffectsToFighterSpawnedByShip ( ShipAPI fighter,
ShipAPI ship,
String id )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.DefectiveManufactory, and com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray.

Definition at line 260 of file BaseHullMod.java.

◆ canBeAddedOrRemovedNow()

boolean com.fs.starfarer.api.combat.BaseHullMod.canBeAddedOrRemovedNow ( ShipAPI ship,
MarketAPI marketOrNull,
CoreUITradeMode mode )

Ship may be null from autofit.

Parameters
ship
marketOrNull
mode
Returns

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.PDIntegration.

Definition at line 91 of file BaseHullMod.java.

◆ getBorderColor()

Color com.fs.starfarer.api.combat.BaseHullMod.getBorderColor ( )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 296 of file BaseHullMod.java.

◆ getCanNotBeInstalledNowReason()

String com.fs.starfarer.api.combat.BaseHullMod.getCanNotBeInstalledNowReason ( ShipAPI ship,
MarketAPI marketOrNull,
CoreUITradeMode mode )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.PDIntegration.

Definition at line 108 of file BaseHullMod.java.

◆ getDescriptionParam() [1/2]

String com.fs.starfarer.api.combat.BaseHullMod.getDescriptionParam ( int index,
HullSize hullSize )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.ShroudedLensHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedMantleHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedThunderheadHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.hullmods.AblativeArmor, com.fs.starfarer.api.impl.hullmods.AdaptivePhaseCoils, com.fs.starfarer.api.impl.hullmods.AdditionalBerthing, com.fs.starfarer.api.impl.hullmods.AdvancedGroundSupport, com.fs.starfarer.api.impl.hullmods.AndradaMods, com.fs.starfarer.api.impl.hullmods.AssaultPackage, com.fs.starfarer.api.impl.hullmods.Automated, com.fs.starfarer.api.impl.hullmods.AuxiliaryFuelTanks, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BDeck, com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.DesignCompromises, com.fs.starfarer.api.impl.hullmods.DistributedFireControl, com.fs.starfarer.api.impl.hullmods.DriveFieldStabilizer, com.fs.starfarer.api.impl.hullmods.ECMPackage, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.ExpandedCargoHolds, com.fs.starfarer.api.impl.hullmods.ExpandedDeckCrew, com.fs.starfarer.api.impl.hullmods.ExperimentalPhaseCoils, com.fs.starfarer.api.impl.hullmods.FighterChassisStorage, com.fs.starfarer.api.impl.hullmods.GroundSupport, com.fs.starfarer.api.impl.hullmods.HeavyBallisticsIntegration, com.fs.starfarer.api.impl.hullmods.HighEfficiencyDriveField, com.fs.starfarer.api.impl.hullmods.HighResSensors, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.MilitarizedSubsystems, com.fs.starfarer.api.impl.hullmods.NavRelay, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.OperationsCenter, com.fs.starfarer.api.impl.hullmods.PeriodicMissileReload, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.PhaseField, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, com.fs.starfarer.api.impl.hullmods.RuggedConstruction, com.fs.starfarer.api.impl.hullmods.ShieldAlwaysOn, com.fs.starfarer.api.impl.hullmods.ShieldShunt, com.fs.starfarer.api.impl.hullmods.TerminatorCore, and com.fs.starfarer.api.impl.hullmods.VastHangar.

Definition at line 53 of file BaseHullMod.java.

◆ getDescriptionParam() [2/2]

String com.fs.starfarer.api.combat.BaseHullMod.getDescriptionParam ( int index,
HullSize hullSize,
ShipAPI ship )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.CompromisedStorage, com.fs.starfarer.api.impl.hullmods.CompromisedStructure, com.fs.starfarer.api.impl.hullmods.DamagedFlightDeck, com.fs.starfarer.api.impl.hullmods.DamagedWeaponMounts, com.fs.starfarer.api.impl.hullmods.DefectiveManufactory, com.fs.starfarer.api.impl.hullmods.DegradedLifeSupport, com.fs.starfarer.api.impl.hullmods.DegradedShields, com.fs.starfarer.api.impl.hullmods.EfficiencyOverhaul, com.fs.starfarer.api.impl.hullmods.ErraticInjector, com.fs.starfarer.api.impl.hullmods.FaultyAutomatedSystems, com.fs.starfarer.api.impl.hullmods.FragileSubsystems, com.fs.starfarer.api.impl.hullmods.GlitchedSensorArray, com.fs.starfarer.api.impl.hullmods.IncreasedMaintenance, com.fs.starfarer.api.impl.hullmods.MalfunctioningComms, com.fs.starfarer.api.impl.hullmods.PDIntegration, and com.fs.starfarer.api.impl.hullmods.SharedFluxSink.

Definition at line 57 of file BaseHullMod.java.

◆ getDisplayCategoryIndex()

int com.fs.starfarer.api.combat.BaseHullMod.getDisplayCategoryIndex ( )

Should return 0 to 4; -1 for "use default". The default categories are: 0: built-in mods in the base hull 1: perma-mods that are not story point mods 2: d-mods 3: mods built in via story points 4: regular mods

Returns

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 313 of file BaseHullMod.java.

◆ getDisplaySortOrder()

int com.fs.starfarer.api.combat.BaseHullMod.getDisplaySortOrder ( )

Sort order within the mod's display category. Not used when category == 4, since then the order is determined by the order in which the player added the hullmods.

Returns

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 306 of file BaseHullMod.java.

◆ getNameColor()

Color com.fs.starfarer.api.combat.BaseHullMod.getNameColor ( )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 301 of file BaseHullMod.java.

◆ getSModDescriptionParam() [1/2]

String com.fs.starfarer.api.combat.BaseHullMod.getSModDescriptionParam ( int index,
HullSize hullSize )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.HighResSensors, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, and com.fs.starfarer.api.impl.hullmods.ShieldShunt.

Definition at line 61 of file BaseHullMod.java.

◆ getSModDescriptionParam() [2/2]

String com.fs.starfarer.api.combat.BaseHullMod.getSModDescriptionParam ( int index,
HullSize hullSize,
ShipAPI ship )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.dweller.ShroudedMantleHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.EfficiencyOverhaul, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, and com.fs.starfarer.api.impl.hullmods.MissileAutoloader.

Definition at line 65 of file BaseHullMod.java.

◆ getTooltipWidth()

float com.fs.starfarer.api.combat.BaseHullMod.getTooltipWidth ( )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, and com.fs.starfarer.api.impl.hullmods.BallisticRangefinder.

Definition at line 320 of file BaseHullMod.java.

◆ getUnapplicableReason()

String com.fs.starfarer.api.combat.BaseHullMod.getUnapplicableReason ( ShipAPI ship)

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.dweller.HumanShipShroudedHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.hullmods.AdaptivePhaseCoils, com.fs.starfarer.api.impl.hullmods.AssaultPackage, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BaseLogisticsHullMod, com.fs.starfarer.api.impl.hullmods.CompromisedStorage, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.ExpandedDeckCrew, com.fs.starfarer.api.impl.hullmods.FighterChassisStorage, com.fs.starfarer.api.impl.hullmods.FragileSubsystems, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.MilitarizedSubsystems, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NeuralIntegrator, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, and com.fs.starfarer.api.impl.hullmods.ShieldShunt.

Definition at line 83 of file BaseHullMod.java.

◆ hasSModEffect()

boolean com.fs.starfarer.api.combat.BaseHullMod.hasSModEffect ( )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.hullmods.ShieldShunt.

Definition at line 149 of file BaseHullMod.java.

◆ hasSModEffectSection()

boolean com.fs.starfarer.api.combat.BaseHullMod.hasSModEffectSection ( HullSize hullSize,
ShipAPI ship,
boolean isForModSpec )

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 134 of file BaseHullMod.java.

◆ init()

void com.fs.starfarer.api.combat.BaseHullMod.init ( HullModSpecAPI spec)

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 25 of file BaseHullMod.java.

◆ isApplicableToShip()

boolean com.fs.starfarer.api.combat.BaseHullMod.isApplicableToShip ( ShipAPI ship)

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.dweller.HumanShipShroudedHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentCoordinatorHullmod, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod, com.fs.starfarer.api.impl.hullmods.AdaptivePhaseCoils, com.fs.starfarer.api.impl.hullmods.AssaultPackage, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.BaseLogisticsHullMod, com.fs.starfarer.api.impl.hullmods.CompromisedStorage, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.DefensiveTargetingArray, com.fs.starfarer.api.impl.hullmods.EscortPackage, com.fs.starfarer.api.impl.hullmods.ExpandedDeckCrew, com.fs.starfarer.api.impl.hullmods.FighterChassisStorage, com.fs.starfarer.api.impl.hullmods.FragileSubsystems, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.MilitarizedSubsystems, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, com.fs.starfarer.api.impl.hullmods.NeuralIntegrator, com.fs.starfarer.api.impl.hullmods.NeuralInterface, com.fs.starfarer.api.impl.hullmods.PhaseAnchor, com.fs.starfarer.api.impl.hullmods.RecoveryShuttles, and com.fs.starfarer.api.impl.hullmods.ShieldShunt.

Definition at line 70 of file BaseHullMod.java.

◆ isBuiltIn()

boolean com.fs.starfarer.api.combat.BaseHullMod.isBuiltIn ( ShipAPI ship)

Definition at line 40 of file BaseHullMod.java.

◆ isInPlayerFleet() [1/2]

boolean com.fs.starfarer.api.combat.BaseHullMod.isInPlayerFleet ( MutableShipStatsAPI stats)

Definition at line 276 of file BaseHullMod.java.

◆ isInPlayerFleet() [2/2]

boolean com.fs.starfarer.api.combat.BaseHullMod.isInPlayerFleet ( ShipAPI ship)

Definition at line 286 of file BaseHullMod.java.

◆ isSMod() [1/2]

boolean com.fs.starfarer.api.combat.BaseHullMod.isSMod ( MutableShipStatsAPI stats)

Definition at line 30 of file BaseHullMod.java.

◆ isSMod() [2/2]

boolean com.fs.starfarer.api.combat.BaseHullMod.isSMod ( ShipAPI ship)

Definition at line 35 of file BaseHullMod.java.

◆ isSModEffectAPenalty()

boolean com.fs.starfarer.api.combat.BaseHullMod.isSModEffectAPenalty ( )

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, and com.fs.starfarer.api.impl.hullmods.MissileAutoloader.

Definition at line 145 of file BaseHullMod.java.

◆ shipHasOtherModInCategory()

boolean com.fs.starfarer.api.combat.BaseHullMod.shipHasOtherModInCategory ( ShipAPI ship,
String currMod,
String category )

Definition at line 265 of file BaseHullMod.java.

◆ shouldAddDescriptionToTooltip()

boolean com.fs.starfarer.api.combat.BaseHullMod.shouldAddDescriptionToTooltip ( HullSize hullSize,
ShipAPI ship,
boolean isForModSpec )

ship may be null, will be for modspecs. hullsize will always be CAPITAL_SHIP for modspecs.

Parameters
hullSize
ship
isForModSpec
Returns

Implements com.fs.starfarer.api.combat.HullModEffect.

Reimplemented in com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.combat.dweller.ShroudedLensHullmod, com.fs.starfarer.api.impl.combat.dweller.ShroudedThunderheadHullmod, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, com.fs.starfarer.api.impl.hullmods.BallisticRangefinder, com.fs.starfarer.api.impl.hullmods.ConvertedHangar, com.fs.starfarer.api.impl.hullmods.EnergyBoltCoherer, com.fs.starfarer.api.impl.hullmods.HighResSensors, com.fs.starfarer.api.impl.hullmods.HighScatterAmp, com.fs.starfarer.api.impl.hullmods.MissileAutoloader, and com.fs.starfarer.api.impl.hullmods.PhaseField.

Definition at line 126 of file BaseHullMod.java.

◆ showInRefitScreenModPickerFor()

boolean com.fs.starfarer.api.combat.BaseHullMod.showInRefitScreenModPickerFor ( ShipAPI ship)

Implements com.fs.starfarer.api.combat.HullModEffect.

Definition at line 324 of file BaseHullMod.java.

Member Data Documentation

◆ spec

HullModSpecAPI com.fs.starfarer.api.combat.BaseHullMod.spec
protected

Definition at line 23 of file BaseHullMod.java.

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