com.fs.starfarer.api.impl.hullmods

Class EscortPackage

java.lang.Object

com.fs.starfarer.api.combat.BaseHullMod

com.fs.starfarer.api.impl.hullmods.EscortPackage

All Implemented Interfaces:

HullModEffect

public class EscortPackage
extends BaseHullMod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EscortPackage.EscortPackageData

Field Summary

Fields

Modifier and Type	Field and Description
static float	EFFECT_FADE
static float	EFFECT_RANGE
static java.lang.String	EP_DATA_KEY
static float	MANEUVER_BONUS
static float	RANGE_BONUS
static float	SHIELD_BONUS
static float	SPEED_BONUS
static java.lang.Object	STATUS_KEY

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

spec

Constructor Summary

Constructors

Constructor and Description
EscortPackage()

Method Summary

Modifier and Type	Method and Description
void	advanceInCombat(ShipAPI ship, float amount) Not called while paused.
void	applyEPEffect(ShipAPI ship, ShipAPI other, float mag)
java.lang.String	getDescriptionParam(int index, ShipAPI.HullSize hullSize)
java.lang.String	getSModDescriptionParam(int index, ShipAPI.HullSize hullSize)
java.lang.String	getUnapplicableReason(ShipAPI ship)
boolean	isApplicableToShip(ShipAPI ship)

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

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

Field Detail

MANEUVER_BONUS

public static float MANEUVER_BONUS

SPEED_BONUS

public static float SPEED_BONUS

RANGE_BONUS

public static float RANGE_BONUS

SHIELD_BONUS

public static float SHIELD_BONUS

EFFECT_RANGE

public static float EFFECT_RANGE

EFFECT_FADE

public static float EFFECT_FADE

STATUS_KEY

public static java.lang.Object STATUS_KEY

EP_DATA_KEY

public static java.lang.String EP_DATA_KEY

Constructor Detail

EscortPackage

public EscortPackage()

Method Detail

getDescriptionParam

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

Specified by:

getDescriptionParam in interface HullModEffect

Overrides:

getDescriptionParam in class BaseHullMod

getSModDescriptionParam

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

Specified by:

getSModDescriptionParam in interface HullModEffect

Overrides:

getSModDescriptionParam in class BaseHullMod

isApplicableToShip

public boolean isApplicableToShip(ShipAPI ship)

Specified by:

isApplicableToShip in interface HullModEffect

Overrides:

isApplicableToShip in class BaseHullMod

getUnapplicableReason

public java.lang.String getUnapplicableReason(ShipAPI ship)

Specified by:

getUnapplicableReason in interface HullModEffect

Overrides:

getUnapplicableReason in class BaseHullMod

applyEPEffect

public void applyEPEffect(ShipAPI ship,
                          ShipAPI other,
                          float mag)

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