com.fs.starfarer.api.impl.hullmods

Class PhaseField

java.lang.Object

com.fs.starfarer.api.combat.BaseHullMod

com.fs.starfarer.api.impl.hullmods.PhaseField

All Implemented Interfaces:

HullModEffect, HullModFleetEffect

public class PhaseField
extends BaseHullMod
implements HullModFleetEffect

Field Summary

Fields

Modifier and Type	Field and Description
static float	MIN_CR
static float	MIN_FIELD_MULT
static java.lang.String	MOD_KEY
static float	PROFILE_MULT

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

spec

Constructor Summary

Constructors

Constructor and Description
PhaseField()

Method Summary

Modifier and Type	Method and Description
void	addPostDescriptionSection(TooltipMakerAPI tooltip, ShipAPI.HullSize hullSize, ShipAPI ship, float width, boolean isForModSpec) ship may be null, will be for modspecs.
void	advanceInCampaign(CampaignFleetAPI fleet) Called for *every* fleet, even fleets that don't have a ship with the specific hullmod.
void	applyEffectsBeforeShipCreation(ShipAPI.HullSize hullSize, MutableShipStatsAPI stats, java.lang.String id)
java.lang.String	getDescriptionParam(int index, ShipAPI.HullSize hullSize)
static float[]	getPhaseFieldMultBaseProfileAndTotal(CampaignFleetAPI fleet, java.lang.String skipId, float addProfile, float addSensor)
static float	getTopKValuesSum(float[] arr, int k)
void	onFleetSync(CampaignFleetAPI fleet) Called when anything about the fleet composition changes, including hullmod changes.
boolean	shouldAddDescriptionToTooltip(ShipAPI.HullSize hullSize, ShipAPI ship, boolean isForModSpec) ship may be null, will be for modspecs.
boolean	withAdvanceInCampaign() Whether the advanceInCampaign() method should be called for this hullmod.
boolean	withOnFleetSync() Whether the withOnFleetSync() method should be called for this hullmod.

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

addRequiredItemSection, addSModEffectSection, addSModSection, advanceInCampaign, advanceInCombat, affectsOPCosts, applyEffectsAfterShipCreation, applyEffectsToFighterSpawnedByShip, canBeAddedOrRemovedNow, getBorderColor, getCanNotBeInstalledNowReason, getDescriptionParam, getDisplayCategoryIndex, getDisplaySortOrder, getNameColor, getSModDescriptionParam, getSModDescriptionParam, getTooltipWidth, getUnapplicableReason, hasSModEffect, hasSModEffectSection, init, isApplicableToShip, isBuiltIn, isInPlayerFleet, isInPlayerFleet, isSMod, isSMod, isSModEffectAPenalty, shipHasOtherModInCategory, 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, getRequiredItem

Field Detail

MIN_CR

public static float MIN_CR

MOD_KEY

public static java.lang.String MOD_KEY

PROFILE_MULT

public static float PROFILE_MULT

MIN_FIELD_MULT

public static float MIN_FIELD_MULT

Constructor Detail

PhaseField

public PhaseField()

Method Detail

applyEffectsBeforeShipCreation

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

Specified by:

applyEffectsBeforeShipCreation in interface HullModEffect

Overrides:

applyEffectsBeforeShipCreation in class BaseHullMod

getDescriptionParam

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

Specified by:

getDescriptionParam in interface HullModEffect

Overrides:

getDescriptionParam in class BaseHullMod

advanceInCampaign

public void advanceInCampaign(CampaignFleetAPI fleet)

Description copied from interface: HullModFleetEffect

Called for *every* fleet, even fleets that don't have a ship with the specific hullmod. Shouldn't try to do a lot here; could have a lot of performance repercussions.

Specified by:

advanceInCampaign in interface HullModFleetEffect

withAdvanceInCampaign

public boolean withAdvanceInCampaign()

Description copied from interface: HullModFleetEffect

Whether the advanceInCampaign() method should be called for this hullmod.

Specified by:

withAdvanceInCampaign in interface HullModFleetEffect

Returns:

withOnFleetSync

public boolean withOnFleetSync()

Description copied from interface: HullModFleetEffect

Whether the withOnFleetSync() method should be called for this hullmod.

Specified by:

withOnFleetSync in interface HullModFleetEffect

Returns:

onFleetSync

public void onFleetSync(CampaignFleetAPI fleet)

Description copied from interface: HullModFleetEffect

Called when anything about the fleet composition changes, including hullmod changes. Also called for all fleets, including fleets without ships with this hullmod.

Specified by:

onFleetSync in interface HullModFleetEffect

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

Overrides:

shouldAddDescriptionToTooltip in class BaseHullMod

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

Overrides:

addPostDescriptionSection in class BaseHullMod

getPhaseFieldMultBaseProfileAndTotal

public static float[] getPhaseFieldMultBaseProfileAndTotal(CampaignFleetAPI fleet,
                                                           java.lang.String skipId,
                                                           float addProfile,
                                                           float addSensor)

getTopKValuesSum

public static float getTopKValuesSum(float[] arr,
                                     int k)