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

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

Classes
class	ShipStatusItem

Public Member Functions
void	init (CombatEngineAPI engine, BattleObjectiveAPI objective)
void	advance (float amount)
List< ShipStatusItem >	getStatusItemsFor (ShipAPI ship)
String	getLongDescription ()
int	getBonusDeploymentPoints ()

Detailed Description

Definition at line 5 of file BattleObjectiveEffect.java.

Member Function Documentation

advance()

void com.fs.starfarer.api.combat.BattleObjectiveEffect.advance

(

float

amount

)

Apply/unapply effects here.

Parameters

amount

Implemented in com.fs.starfarer.api.impl.combat.CommRelayEffect, com.fs.starfarer.api.impl.combat.NavBuoyEffect, and com.fs.starfarer.api.impl.combat.SensorArrayEffect.

getBonusDeploymentPoints()

int com.fs.starfarer.api.combat.BattleObjectiveEffect.getBonusDeploymentPoints

(

)

Implemented in com.fs.starfarer.api.impl.combat.BaseBattleObjectiveEffect.

getLongDescription()

String com.fs.starfarer.api.combat.BattleObjectiveEffect.getLongDescription

(

)

Implemented in com.fs.starfarer.api.impl.combat.CommRelayEffect, com.fs.starfarer.api.impl.combat.NavBuoyEffect, and com.fs.starfarer.api.impl.combat.SensorArrayEffect.

getStatusItemsFor()

List< ShipStatusItem > com.fs.starfarer.api.combat.BattleObjectiveEffect.getStatusItemsFor

(

ShipAPI

ship

)

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

Parameters

ship

Returns

Implemented in com.fs.starfarer.api.impl.combat.CommRelayEffect, com.fs.starfarer.api.impl.combat.NavBuoyEffect, and com.fs.starfarer.api.impl.combat.SensorArrayEffect.

init()

void com.fs.starfarer.api.combat.BattleObjectiveEffect.init	(	CombatEngineAPI	engine,
		BattleObjectiveAPI	objective )

Implemented in com.fs.starfarer.api.impl.combat.BaseBattleObjectiveEffect, com.fs.starfarer.api.impl.combat.CommRelayEffect, com.fs.starfarer.api.impl.combat.NavBuoyEffect, and com.fs.starfarer.api.impl.combat.SensorArrayEffect.

---

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

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