com.fs.starfarer.api.combat

Interface HullModFleetEffect

All Known Implementing Classes:

HighResSensors, PhaseField

public interface HullModFleetEffect

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.

Method Summary

Modifier and Type	Method and Description
void	advanceInCampaign(CampaignFleetAPI fleet) Called for *every* fleet, even fleets that don't have a ship with the specific hullmod.
void	onFleetSync(CampaignFleetAPI fleet) Called when anything about the fleet composition changes, including hullmod changes.
boolean	withAdvanceInCampaign() Whether the advanceInCampaign() method should be called for this hullmod.
boolean	withOnFleetSync() Whether the withOnFleetSync() method should be called for this hullmod.

Method Detail

advanceInCampaign

void 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 -

withAdvanceInCampaign

boolean withAdvanceInCampaign()

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

Returns:

withOnFleetSync

boolean withOnFleetSync()

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

Returns:

onFleetSync

void 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 -