Starsector API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
com.fs.starfarer.api.combat.HullModEffect Interface Reference
Inheritance diagram for com.fs.starfarer.api.combat.HullModEffect:
[legend]

Public Member Functions

void init (HullModSpecAPI spec)
 
void applyEffectsBeforeShipCreation (HullSize hullSize, MutableShipStatsAPI stats, String id)
 
void applyEffectsAfterShipCreation (ShipAPI ship, String id)
 
String getDescriptionParam (int index, HullSize hullSize)
 
String getDescriptionParam (int index, HullSize hullSize, ShipAPI ship)
 
void applyEffectsToFighterSpawnedByShip (ShipAPI fighter, ShipAPI ship, String id)
 
boolean isApplicableToShip (ShipAPI ship)
 
String getUnapplicableReason (ShipAPI ship)
 
boolean canBeAddedOrRemovedNow (ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode)
 
String getCanNotBeInstalledNowReason (ShipAPI ship, MarketAPI marketOrNull, CoreUITradeMode mode)
 
void advanceInCampaign (FleetMemberAPI member, float amount)
 
void advanceInCombat (ShipAPI ship, float amount)
 
boolean affectsOPCosts ()
 
boolean shouldAddDescriptionToTooltip (HullSize hullSize, ShipAPI ship, boolean isForModSpec)
 
void addPostDescriptionSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec)
 
Color getBorderColor ()
 
Color getNameColor ()
 
int getDisplaySortOrder ()
 
int getDisplayCategoryIndex ()
 
boolean hasSModEffectSection (HullSize hullSize, ShipAPI ship, boolean isForModSpec)
 
void addSModSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
 
void addSModEffectSection (TooltipMakerAPI tooltip, HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
 
boolean hasSModEffect ()
 
void addRequiredItemSection (TooltipMakerAPI tooltip, FleetMemberAPI member, ShipVariantAPI currentVariant, MarketAPI dockedAt, float width, boolean isForModSpec)
 
String getSModDescriptionParam (int index, HullSize hullSize)
 
String getSModDescriptionParam (int index, HullSize hullSize, ShipAPI ship)
 
float getTooltipWidth ()
 
boolean isSModEffectAPenalty ()
 
boolean showInRefitScreenModPickerFor (ShipAPI ship)
 
default CargoStackAPI getRequiredItem ()
 
default void applyEffectsAfterShipAddedToCombatEngine (ShipAPI ship, String id)
 

Detailed Description

Note: the effect class is instantiated once per application session. Storing campaign data in data members of an implementing class is a bad idea (will likely cause memory leaks), use SectorAPI.getPersistentData() instead.

Author
Alex Mosolov

Copyright 2015 Fractal Softworks, LLC

Definition at line 21 of file HullModEffect.java.

Member Function Documentation

◆ addPostDescriptionSection()

void com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ addRequiredItemSection()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ addSModEffectSection()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ addSModSection()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ advanceInCampaign()

void com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ advanceInCombat()

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

Not called while paused.

Parameters
ship
amount

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ affectsOPCosts()

boolean com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ applyEffectsAfterShipAddedToCombatEngine()

default void com.fs.starfarer.api.combat.HullModEffect.applyEffectsAfterShipAddedToCombatEngine ( ShipAPI ship,
String id )

Only called once. Not called again if the ship is removed and then added back to the engine.

Implemented in com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod, and com.fs.starfarer.api.impl.combat.threat.ThreatHullmod.

Definition at line 146 of file HullModEffect.java.

◆ applyEffectsAfterShipCreation()

void com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ applyEffectsBeforeShipCreation()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ applyEffectsToFighterSpawnedByShip()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ canBeAddedOrRemovedNow()

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

Ship may be null from autofit.

Parameters
ship
marketOrNull
mode
Returns

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, and com.fs.starfarer.api.impl.hullmods.PDIntegration.

◆ getBorderColor()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ getCanNotBeInstalledNowReason()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, and com.fs.starfarer.api.impl.hullmods.PDIntegration.

◆ getDescriptionParam() [1/2]

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ getDescriptionParam() [2/2]

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ getDisplayCategoryIndex()

int com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ getDisplaySortOrder()

int com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ getNameColor()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ getRequiredItem()

default CargoStackAPI com.fs.starfarer.api.combat.HullModEffect.getRequiredItem ( )

Implemented in 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, and com.fs.starfarer.api.impl.combat.threat.SecondaryFabricatorHullmod.

Definition at line 139 of file HullModEffect.java.

◆ getSModDescriptionParam() [1/2]

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ getSModDescriptionParam() [2/2]

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ getTooltipWidth()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, com.fs.starfarer.api.impl.combat.threat.ThreatHullmod, and com.fs.starfarer.api.impl.hullmods.BallisticRangefinder.

◆ getUnapplicableReason()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ hasSModEffect()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, and com.fs.starfarer.api.impl.hullmods.ShieldShunt.

◆ hasSModEffectSection()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ init()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

◆ isApplicableToShip()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ isSModEffectAPenalty()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.TowCable, com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod, and com.fs.starfarer.api.impl.hullmods.MissileAutoloader.

◆ shouldAddDescriptionToTooltip()

boolean com.fs.starfarer.api.combat.HullModEffect.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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, com.fs.starfarer.api.impl.campaign.RepairGantry, com.fs.starfarer.api.impl.campaign.TowCable, 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.

◆ showInRefitScreenModPickerFor()

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

Implemented in com.fs.starfarer.api.combat.BaseHullMod, and com.fs.starfarer.api.impl.campaign.TowCable.

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