Package com.fs.starfarer.api.combat

Interface BattleObjectiveEffect

All Known Implementing Classes:

BaseBattleObjectiveEffect, CommRelayEffect, NavBuoyEffect, SensorArrayEffect

public interface BattleObjectiveEffect

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BattleObjectiveEffect.ShipStatusItem

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Apply/unapply effects here.
int	getBonusDeploymentPoints()
String	getLongDescription()
List<BattleObjectiveEffect.ShipStatusItem>	getStatusItemsFor(ShipAPI ship)	Must return null if this objective has no effect on the passed in ship.
void	init(CombatEngineAPI engine, BattleObjectiveAPI objective)

Method Details

init

void init(CombatEngineAPI engine,
 BattleObjectiveAPI objective)

advance

void advance(float amount)

Apply/unapply effects here.

Parameters:

amount -

getStatusItemsFor

List<BattleObjectiveEffect.ShipStatusItem> getStatusItemsFor(ShipAPI ship)

Must return null if this objective has no effect on the passed in ship.

Parameters:

ship -

Returns:

getLongDescription

String getLongDescription()

getBonusDeploymentPoints

int getBonusDeploymentPoints()