com.fs.starfarer.api.combat.HullModFleetEffect Interface Reference

Inheritance diagram for com.fs.starfarer.api.combat.HullModFleetEffect:

Public Member Functions
void	advanceInCampaign (CampaignFleetAPI fleet)
boolean	withAdvanceInCampaign ()
boolean	withOnFleetSync ()
void	onFleetSync (CampaignFleetAPI fleet)

Detailed Description

Implement this in addition to HullModEffect, not by itself.

Note: the effect class is instantiated once per application session. Storing campaign data in members of an implementing class is a bad idea, use SectorAPI.getPersistentData() instead.

Author

Alex Mosolov

Copyright 2013 Fractal Softworks, LLC

Definition at line 16 of file HullModFleetEffect.java.

Member Function Documentation

advanceInCampaign()

void com.fs.starfarer.api.combat.HullModFleetEffect.advanceInCampaign

(

CampaignFleetAPI

fleet

)

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.

Parameters

fleet

Implemented in com.fs.starfarer.api.impl.hullmods.HighResSensors, and com.fs.starfarer.api.impl.hullmods.PhaseField.

onFleetSync()

void com.fs.starfarer.api.combat.HullModFleetEffect.onFleetSync

(

CampaignFleetAPI

fleet

)

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

Parameters

fleet

Implemented in com.fs.starfarer.api.impl.hullmods.HighResSensors, and com.fs.starfarer.api.impl.hullmods.PhaseField.

withAdvanceInCampaign()

boolean com.fs.starfarer.api.combat.HullModFleetEffect.withAdvanceInCampaign

(

)

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

Returns

Implemented in com.fs.starfarer.api.impl.hullmods.HighResSensors, and com.fs.starfarer.api.impl.hullmods.PhaseField.

withOnFleetSync()

boolean com.fs.starfarer.api.combat.HullModFleetEffect.withOnFleetSync

(

)

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

Returns

Implemented in com.fs.starfarer.api.impl.hullmods.HighResSensors, and com.fs.starfarer.api.impl.hullmods.PhaseField.

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/combat/HullModFleetEffect.java