Package com.fs.starfarer.api.impl.campaign

Class TowCable

java.lang.Object

com.fs.starfarer.api.impl.campaign.TowCable

All Implemented Interfaces:

HullModEffect

public class TowCable
extends Object
implements HullModEffect

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TowCable.TowCableBuff

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HULLMOD_ID
static final String	TOW_CABLE_KEY	One instance of the buff object per ship with a Tow Cable.

Constructor Summary

Constructors

Constructor	Description
TowCable()

Method Summary

Modifier and Type	Method	Description
void	addPostDescriptionSection(TooltipMakerAPI tooltip, ShipAPI.HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec)	ship may be null, will be for modspecs.
void	addRequiredItemSection(TooltipMakerAPI tooltip, FleetMemberAPI member, ShipVariantAPI currentVariant, MarketAPI dockedAt, float width, boolean isForModSpec)
void	addSModEffectSection(TooltipMakerAPI tooltip, ShipAPI.HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
void	addSModSection(TooltipMakerAPI tooltip, ShipAPI.HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec)
void	addSModSection(TooltipMakerAPI tooltip, ShipAPI.HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec, boolean isForBuildInList)
void	advanceInCampaign(FleetMemberAPI member, float amount)	Not called while paused.
void	advanceInCombat(ShipAPI ship, float amount)	Not called while paused.
boolean	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.
void	applyEffectsAfterShipCreation(ShipAPI ship, String id)	Effects applied here should NOT affect ship stats as this does not get called from the campaign.
void	applyEffectsBeforeShipCreation(ShipAPI.HullSize hullSize, MutableShipStatsAPI stats, String id)
void	applyEffectsToFighterSpawnedByShip(ShipAPI fighter, ShipAPI ship, String id)
boolean	canBeAddedOrRemovedNow(ShipAPI ship, MarketAPI marketOrNull, CampaignUIAPI.CoreUITradeMode mode)	Ship may be null from autofit.
Color	getBorderColor()
String	getCanNotBeInstalledNowReason(ShipAPI ship, MarketAPI marketOrNull, CampaignUIAPI.CoreUITradeMode mode)
String	getDescriptionParam(int index, ShipAPI.HullSize hullSize)
String	getDescriptionParam(int index, ShipAPI.HullSize hullSize, ShipAPI ship)
int	getDisplayCategoryIndex()	Should return 0 to 4; -1 for "use default".
int	getDisplaySortOrder()	Sort order within the mod's display category.
Color	getNameColor()
String	getSModDescriptionParam(int index, ShipAPI.HullSize hullSize)
String	getSModDescriptionParam(int index, ShipAPI.HullSize hullSize, ShipAPI ship)
float	getTooltipWidth()
String	getUnapplicableReason(ShipAPI ship)
boolean	hasSModEffect()
boolean	hasSModEffectSection(ShipAPI.HullSize hullSize, ShipAPI ship, boolean isForModSpec)
void	init(HullModSpecAPI spec)
boolean	isApplicableToShip(ShipAPI ship)
boolean	isSModEffectAPenalty()
boolean	shouldAddDescriptionToTooltip(ShipAPI.HullSize hullSize, ShipAPI ship, boolean isForModSpec)	ship may be null, will be for modspecs.
boolean	showInRefitScreenModPickerFor(ShipAPI ship)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.fs.starfarer.api.combat.HullModEffect

applyEffectsAfterShipAddedToCombatEngine, getRequiredItem

Field Details

HULLMOD_ID

public static final String HULLMOD_ID

See Also:

• Constant Field Values

TOW_CABLE_KEY

public static final String TOW_CABLE_KEY

One instance of the buff object per ship with a Tow Cable.

See Also:

• Constant Field Values

Constructor Details

TowCable

public TowCable()

Method Details

init

public void init(HullModSpecAPI spec)

Specified by:

init in interface HullModEffect

advanceInCampaign

public void advanceInCampaign(FleetMemberAPI member,
 float amount)

Description copied from interface: HullModEffect

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.)

Specified by:

advanceInCampaign in interface HullModEffect

advanceInCombat

public void advanceInCombat(ShipAPI ship,
 float amount)

Description copied from interface: HullModEffect

Not called while paused.

Specified by:

advanceInCombat in interface HullModEffect

applyEffectsAfterShipCreation

public void applyEffectsAfterShipCreation(ShipAPI ship,
 String id)

Description copied from interface: HullModEffect

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.

Specified by:

applyEffectsAfterShipCreation in interface HullModEffect

applyEffectsBeforeShipCreation

public void applyEffectsBeforeShipCreation(ShipAPI.HullSize hullSize,
 MutableShipStatsAPI stats,
 String id)

Specified by:

applyEffectsBeforeShipCreation in interface HullModEffect

isApplicableToShip

public boolean isApplicableToShip(ShipAPI ship)

Specified by:

isApplicableToShip in interface HullModEffect

getDescriptionParam

public String getDescriptionParam(int index,
 ShipAPI.HullSize hullSize)

Specified by:

getDescriptionParam in interface HullModEffect

getUnapplicableReason

public String getUnapplicableReason(ShipAPI ship)

Specified by:

getUnapplicableReason in interface HullModEffect

affectsOPCosts

public boolean affectsOPCosts()

Description copied from interface: HullModEffect

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.

Specified by:

affectsOPCosts in interface HullModEffect

Returns:

getDescriptionParam

public String getDescriptionParam(int index,
 ShipAPI.HullSize hullSize,
 ShipAPI ship)

Specified by:

getDescriptionParam in interface HullModEffect

canBeAddedOrRemovedNow

public boolean canBeAddedOrRemovedNow(ShipAPI ship,
 MarketAPI marketOrNull,
 CampaignUIAPI.CoreUITradeMode mode)

Description copied from interface: HullModEffect

Ship may be null from autofit.

Specified by:

canBeAddedOrRemovedNow in interface HullModEffect

Returns:

getCanNotBeInstalledNowReason

public String getCanNotBeInstalledNowReason(ShipAPI ship,
 MarketAPI marketOrNull,
 CampaignUIAPI.CoreUITradeMode mode)

Specified by:

getCanNotBeInstalledNowReason in interface HullModEffect

shouldAddDescriptionToTooltip

public boolean shouldAddDescriptionToTooltip(ShipAPI.HullSize hullSize,
 ShipAPI ship,
 boolean isForModSpec)

Description copied from interface: HullModEffect

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

Specified by:

shouldAddDescriptionToTooltip in interface HullModEffect

Returns:

addPostDescriptionSection

public void addPostDescriptionSection(TooltipMakerAPI tooltip,
 ShipAPI.HullSize hullSize,
 ShipAPI ship,
 float width,
 boolean isForModSpec)

Description copied from interface: HullModEffect

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

Specified by:

addPostDescriptionSection in interface HullModEffect

applyEffectsToFighterSpawnedByShip

public void applyEffectsToFighterSpawnedByShip(ShipAPI fighter,
 ShipAPI ship,
 String id)

Specified by:

applyEffectsToFighterSpawnedByShip in interface HullModEffect

getBorderColor

public Color getBorderColor()

Specified by:

getBorderColor in interface HullModEffect

getNameColor

public Color getNameColor()

Specified by:

getNameColor in interface HullModEffect

getDisplaySortOrder

public int getDisplaySortOrder()

Description copied from interface: HullModEffect

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.

Specified by:

getDisplaySortOrder in interface HullModEffect

Returns:

getDisplayCategoryIndex

public int getDisplayCategoryIndex()

Description copied from interface: HullModEffect

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

Specified by:

getDisplayCategoryIndex in interface HullModEffect

Returns:

hasSModEffectSection

public boolean hasSModEffectSection(ShipAPI.HullSize hullSize,
 ShipAPI ship,
 boolean isForModSpec)

Specified by:

hasSModEffectSection in interface HullModEffect

addSModSection

public void addSModSection(TooltipMakerAPI tooltip,
 ShipAPI.HullSize hullSize,
 ShipAPI ship,
 float width,
 boolean isForModSpec)

addSModEffectSection

public void addSModEffectSection(TooltipMakerAPI tooltip,
 ShipAPI.HullSize hullSize,
 ShipAPI ship,
 float width,
 boolean isForModSpec,
 boolean isForBuildInList)

Specified by:

addSModEffectSection in interface HullModEffect

addSModSection

public void addSModSection(TooltipMakerAPI tooltip,
 ShipAPI.HullSize hullSize,
 ShipAPI ship,
 float width,
 boolean isForModSpec,
 boolean isForBuildInList)

Specified by:

addSModSection in interface HullModEffect

hasSModEffect

public boolean hasSModEffect()

Specified by:

hasSModEffect in interface HullModEffect

getSModDescriptionParam

public String getSModDescriptionParam(int index,
 ShipAPI.HullSize hullSize)

Specified by:

getSModDescriptionParam in interface HullModEffect

getSModDescriptionParam

public String getSModDescriptionParam(int index,
 ShipAPI.HullSize hullSize,
 ShipAPI ship)

Specified by:

getSModDescriptionParam in interface HullModEffect

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface HullModEffect

isSModEffectAPenalty

public boolean isSModEffectAPenalty()

Specified by:

isSModEffectAPenalty in interface HullModEffect

showInRefitScreenModPickerFor

public boolean showInRefitScreenModPickerFor(ShipAPI ship)

Specified by:

showInRefitScreenModPickerFor in interface HullModEffect

addRequiredItemSection

public void addRequiredItemSection(TooltipMakerAPI tooltip,
 FleetMemberAPI member,
 ShipVariantAPI currentVariant,
 MarketAPI dockedAt,
 float width,
 boolean isForModSpec)

Specified by:

addRequiredItemSection in interface HullModEffect