Package com.fs.starfarer.api.impl.combat.threat

Class FragmentSwarmHullmod

java.lang.Object

com.fs.starfarer.api.combat.BaseHullMod

com.fs.starfarer.api.impl.combat.threat.FragmentSwarmHullmod

All Implemented Interfaces:

HullModEffect

public class FragmentSwarmHullmod
extends BaseHullMod

Hullmod that creates a fragment swarm around the ship. This swarm is required to power "fragment" weapons.

Author:

Alex

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONSTRUCTION_SWARM_FLOCKING_CLASS
static String	RECLAMATION_SWARM_EXCHANGE_CLASS
static String	RECLAMATION_SWARM_FLOCKING_CLASS
static boolean	SHOW_OVERLAY_ON_THREAT_SHIPS
static float	SMOD_CR_PENALTY
static float	SMOD_MAINTENANCE_PENALTY
static String	STANDARD_SWARM_EXCHANGE_CLASS
static String	STANDARD_SWARM_FLOCKING_CLASS
static Object	STATUS_KEY1

Fields inherited from class com.fs.starfarer.api.combat.BaseHullMod

spec

Constructor Summary

Constructors

Constructor	Description
FragmentSwarmHullmod()

Method Summary

Modifier and Type	Method	Description
void	advanceInCombat(ShipAPI ship, float amount)	Not called while paused.
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)
static RoilingSwarmEffect	createSwarmFor(ShipAPI ship)
static float	getBaseSwarmRespawnRateMult(ShipAPI.HullSize size)
static int	getBaseSwarmSize(ShipAPI.HullSize size)
String	getDescriptionParam(int index, ShipAPI.HullSize hullSize)
CargoStackAPI	getRequiredItem()
String	getSModDescriptionParam(int index, ShipAPI.HullSize hullSize, ShipAPI ship)
String	getUnapplicableReason(ShipAPI ship)
boolean	isApplicableToShip(ShipAPI ship)
boolean	isSModEffectAPenalty()

Methods inherited from class com.fs.starfarer.api.combat.BaseHullMod

addPostDescriptionSection, addRequiredItemSection, addSModEffectSection, addSModSection, advanceInCampaign, affectsOPCosts, applyEffectsToFighterSpawnedByShip, canBeAddedOrRemovedNow, getBorderColor, getCanNotBeInstalledNowReason, getDescriptionParam, getDisplayCategoryIndex, getDisplaySortOrder, getNameColor, getSModDescriptionParam, getTooltipWidth, hasSModEffect, hasSModEffectSection, init, isBuiltIn, isInPlayerFleet, isInPlayerFleet, isSMod, isSMod, shipHasOtherModInCategory, shouldAddDescriptionToTooltip, showInRefitScreenModPickerFor

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

Field Details

STANDARD_SWARM_EXCHANGE_CLASS

public static String STANDARD_SWARM_EXCHANGE_CLASS

STANDARD_SWARM_FLOCKING_CLASS

public static String STANDARD_SWARM_FLOCKING_CLASS

CONSTRUCTION_SWARM_FLOCKING_CLASS

public static String CONSTRUCTION_SWARM_FLOCKING_CLASS

RECLAMATION_SWARM_FLOCKING_CLASS

public static String RECLAMATION_SWARM_FLOCKING_CLASS

RECLAMATION_SWARM_EXCHANGE_CLASS

public static String RECLAMATION_SWARM_EXCHANGE_CLASS

SHOW_OVERLAY_ON_THREAT_SHIPS

public static boolean SHOW_OVERLAY_ON_THREAT_SHIPS

SMOD_CR_PENALTY

public static float SMOD_CR_PENALTY

SMOD_MAINTENANCE_PENALTY

public static float SMOD_MAINTENANCE_PENALTY

STATUS_KEY1

public static Object STATUS_KEY1

Constructor Details

FragmentSwarmHullmod

public FragmentSwarmHullmod()

Method Details

applyEffectsBeforeShipCreation

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

Specified by:

applyEffectsBeforeShipCreation in interface HullModEffect

Overrides:

applyEffectsBeforeShipCreation in class BaseHullMod

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

Overrides:

applyEffectsAfterShipCreation in class BaseHullMod

advanceInCombat

public void advanceInCombat(ShipAPI ship,
 float amount)

Description copied from interface: HullModEffect

Not called while paused.

Specified by:

advanceInCombat in interface HullModEffect

Overrides:

advanceInCombat in class BaseHullMod

createSwarmFor

public static RoilingSwarmEffect createSwarmFor(ShipAPI ship)

getBaseSwarmSize

public static int getBaseSwarmSize(ShipAPI.HullSize size)

getBaseSwarmRespawnRateMult

public static float getBaseSwarmRespawnRateMult(ShipAPI.HullSize size)

getRequiredItem

public CargoStackAPI getRequiredItem()

isApplicableToShip

public boolean isApplicableToShip(ShipAPI ship)

Specified by:

isApplicableToShip in interface HullModEffect

Overrides:

isApplicableToShip in class BaseHullMod

getUnapplicableReason

public String getUnapplicableReason(ShipAPI ship)

Specified by:

getUnapplicableReason in interface HullModEffect

Overrides:

getUnapplicableReason in class BaseHullMod

getDescriptionParam

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

Specified by:

getDescriptionParam in interface HullModEffect

Overrides:

getDescriptionParam in class BaseHullMod

getSModDescriptionParam

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

Specified by:

getSModDescriptionParam in interface HullModEffect

Overrides:

getSModDescriptionParam in class BaseHullMod

isSModEffectAPenalty

public boolean isSModEffectAPenalty()

Specified by:

isSModEffectAPenalty in interface HullModEffect

Overrides:

isSModEffectAPenalty in class BaseHullMod