Package com.fs.starfarer.api.impl.campaign.rulecmd.salvage

Class AddRaidObjective.CustomRaidObjectiveAdder

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.salvage.AddRaidObjective.CustomRaidObjectiveAdder

All Implemented Interfaces:

GroundRaidObjectivesListener, EveryFrameScript

Enclosing class:

AddRaidObjective

public static class AddRaidObjective.CustomRaidObjectiveAdder
extends Object
implements EveryFrameScript, GroundRaidObjectivesListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.listeners.GroundRaidObjectivesListener

GroundRaidObjectivesListener.RaidResultData

Field Summary

Fields

Modifier and Type	Field	Description
MarketCMD.RaidDangerLevel	danger
protected boolean	done
SectorEntityToken	entity
String	icon
MarketAPI	market
String	name
boolean	showInCustomOnly
String	tooltip
String	trigger
int	xp

Constructor Summary

Constructors

Constructor	Description
CustomRaidObjectiveAdder(MarketAPI market, SectorEntityToken entity, String icon, String name, String trigger, int xp, MarketCMD.RaidDangerLevel danger, boolean showInCustomOnly, String tooltip)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
boolean	isDone()
void	modifyRaidObjectives(MarketAPI market, SectorEntityToken entity, List<GroundRaidObjectivePlugin> objectives, MarketCMD.RaidType type, int marineTokens, int priority)	Called 10 times with priority from 0 to 9.
void	reportRaidObjectivesAchieved(GroundRaidObjectivesListener.RaidResultData data, InteractionDialogAPI dialog, Map<String,MemoryAPI> memoryMap)
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

done

protected boolean done

icon

public String icon

name

public String name

trigger

public String trigger

tooltip

public String tooltip

xp

public int xp

showInCustomOnly

public boolean showInCustomOnly

danger

public MarketCMD.RaidDangerLevel danger

market

public MarketAPI market

entity

public SectorEntityToken entity

Constructor Details

CustomRaidObjectiveAdder

public CustomRaidObjectiveAdder(MarketAPI market,
 SectorEntityToken entity,
 String icon,
 String name,
 String trigger,
 int xp,
 MarketCMD.RaidDangerLevel danger,
 boolean showInCustomOnly,
 String tooltip)

Method Details

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

whether advance() should be called while the campaign engine is paused.

modifyRaidObjectives

public void modifyRaidObjectives(MarketAPI market,
 SectorEntityToken entity,
 List<GroundRaidObjectivePlugin> objectives,
 MarketCMD.RaidType type,
 int marineTokens,
 int priority)

Description copied from interface: GroundRaidObjectivesListener

Called 10 times with priority from 0 to 9. An implementation should generally only modify objectives in one of those callse.

Specified by:

modifyRaidObjectives in interface GroundRaidObjectivesListener

reportRaidObjectivesAchieved

public void reportRaidObjectivesAchieved(GroundRaidObjectivesListener.RaidResultData data,
 InteractionDialogAPI dialog,
 Map<String,MemoryAPI> memoryMap)

Specified by:

reportRaidObjectivesAchieved in interface GroundRaidObjectivesListener