com.fs.starfarer.api.impl.combat.dweller

Class DwellerHullmod

java.lang.Object

com.fs.starfarer.api.combat.BaseHullMod

com.fs.starfarer.api.impl.combat.dweller.DwellerHullmod

All Implemented Interfaces:

HullModEffect

Direct Known Subclasses:

HumanShipShroudedHullmod

public class DwellerHullmod
extends BaseHullMod

Required for Shrouded Dweller "ships" - spawns combat entities for custom rendering etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INITED_DWELLER_STUFF
static java.util.Map<java.lang.String,DwellerShipCreator>	SHIP_CREATORS

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

spec

Constructor Summary

Constructors

Constructor and Description
DwellerHullmod()

Method Summary

Modifier and Type	Method and Description
protected boolean	addStrategyAI()
void	advanceInCombat(ShipAPI ship, float amount) Not called while paused.
void	applyEffectsAfterShipAddedToCombatEngine(ShipAPI ship, java.lang.String id) Only called once.
void	applyEffectsAfterShipCreation(ShipAPI ship, java.lang.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, java.lang.String id)
protected DwellerShipCreator	getShipCreator(java.lang.String hullId)

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

addPostDescriptionSection, addRequiredItemSection, addSModEffectSection, addSModSection, advanceInCampaign, affectsOPCosts, applyEffectsToFighterSpawnedByShip, canBeAddedOrRemovedNow, getBorderColor, getCanNotBeInstalledNowReason, getDescriptionParam, getDescriptionParam, getDisplayCategoryIndex, getDisplaySortOrder, getNameColor, getSModDescriptionParam, getSModDescriptionParam, getTooltipWidth, getUnapplicableReason, hasSModEffect, hasSModEffectSection, init, isApplicableToShip, 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

getRequiredItem

Field Detail

SHIP_CREATORS

public static java.util.Map<java.lang.String,DwellerShipCreator> SHIP_CREATORS

INITED_DWELLER_STUFF

public static java.lang.String INITED_DWELLER_STUFF

Constructor Detail

DwellerHullmod

public DwellerHullmod()

Method Detail

getShipCreator

protected DwellerShipCreator getShipCreator(java.lang.String hullId)

addStrategyAI

protected boolean addStrategyAI()

applyEffectsBeforeShipCreation

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

Specified by:

applyEffectsBeforeShipCreation in interface HullModEffect

Overrides:

applyEffectsBeforeShipCreation in class BaseHullMod

applyEffectsAfterShipCreation

public void applyEffectsAfterShipCreation(ShipAPI ship,
                                          java.lang.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

applyEffectsAfterShipAddedToCombatEngine

public void applyEffectsAfterShipAddedToCombatEngine(ShipAPI ship,
                                                     java.lang.String id)

Description copied from interface: HullModEffect

Only called once. Not called again if the ship is removed and then added back to the engine.

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