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

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

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)

Protected Attributes
HullModSpecAPI	spec

Detailed Description

Definition at line 20 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.

Definition at line 129 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 154 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 173 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 74 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.

Definition at line 78 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.

Definition at line 86 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.

Definition at line 45 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.

Definition at line 48 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.

Definition at line 254 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.

Definition at line 90 of file BaseHullMod.java.

◆ getBorderColor()

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

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

Definition at line 290 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.

Definition at line 107 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.

Definition at line 52 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.

Definition at line 56 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 307 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 300 of file BaseHullMod.java.

◆ getNameColor()

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

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

Definition at line 295 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.

Definition at line 60 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.

Definition at line 64 of file BaseHullMod.java.

◆ getTooltipWidth()

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

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

Definition at line 314 of file BaseHullMod.java.

◆ getUnapplicableReason()

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

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

Definition at line 82 of file BaseHullMod.java.

◆ hasSModEffect()

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

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

Definition at line 147 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 133 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 24 of file BaseHullMod.java.

◆ isApplicableToShip()

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

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

Definition at line 69 of file BaseHullMod.java.

◆ isBuiltIn()

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

Definition at line 39 of file BaseHullMod.java.

◆ isInPlayerFleet() [1/2]

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

Definition at line 270 of file BaseHullMod.java.

◆ isInPlayerFleet() [2/2]

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

Definition at line 280 of file BaseHullMod.java.

◆ isSMod() [1/2]

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

Definition at line 29 of file BaseHullMod.java.

◆ isSMod() [2/2]

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

Definition at line 34 of file BaseHullMod.java.

◆ isSModEffectAPenalty()

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

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

Definition at line 143 of file BaseHullMod.java.

◆ shipHasOtherModInCategory()

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

Definition at line 259 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.

Definition at line 125 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 318 of file BaseHullMod.java.

Member Data Documentation

◆ spec

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

protected

Definition at line 22 of file BaseHullMod.java.

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

src/com/fs/starfarer/api/combat/BaseHullMod.java

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addPostDescriptionSection()

◆ addSModEffectSection()

◆ addSModSection()

◆ advanceInCampaign()

◆ advanceInCombat()

◆ affectsOPCosts()

◆ applyEffectsAfterShipCreation()

◆ applyEffectsBeforeShipCreation()

◆ applyEffectsToFighterSpawnedByShip()

◆ canBeAddedOrRemovedNow()

◆ getBorderColor()

◆ getCanNotBeInstalledNowReason()

◆ getDescriptionParam() [1/2]

◆ getDescriptionParam() [2/2]

◆ getDisplayCategoryIndex()

◆ getDisplaySortOrder()

◆ getNameColor()

◆ getSModDescriptionParam() [1/2]

◆ getSModDescriptionParam() [2/2]

◆ getTooltipWidth()

◆ getUnapplicableReason()

◆ hasSModEffect()

◆ hasSModEffectSection()

◆ init()

◆ isApplicableToShip()

◆ isBuiltIn()

◆ isInPlayerFleet() [1/2]

◆ isInPlayerFleet() [2/2]

◆ isSMod() [1/2]

◆ isSMod() [2/2]

◆ isSModEffectAPenalty()

◆ shipHasOtherModInCategory()

◆ shouldAddDescriptionToTooltip()

◆ showInRefitScreenModPickerFor()

Member Data Documentation

◆ spec