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

Class BarCMD

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.BaseCommandPlugin

com.fs.starfarer.api.impl.campaign.rulecmd.missions.BarCMD

All Implemented Interfaces:

InteractionDialogPlugin, CommandPlugin

public class BarCMD
extends BaseCommandPlugin
implements InteractionDialogPlugin

BarCMD

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarCMD.BarAmbiencePlayer

Field Summary

Fields

Modifier and Type	Field	Description
static float	BAR_EVENT_MAX_TIME_BEFORE_CHANGING
static float	BAR_EVENT_MIN_TIME_BEFORE_CHANGING
protected InteractionDialogAPI	dialog
protected SectorEntityToken	entity
protected Map<String,MemoryAPI>	memoryMap
protected InteractionDialogPlugin	originalPlugin

Constructor Summary

Constructors

Constructor	Description
BarCMD()

Method Summary

Modifier and Type	Method	Description
void	abortMissions(String optionId)
void	advance(float amount)
void	backFromEngagement(EngagementResultAPI battleResult)
boolean	execute(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)
static BarCMD.BarAmbiencePlayer	getAmbiencePlayer()
Object	getContext()
Map<String,MemoryAPI>	getMemoryMap()
HubMissionBarEventWrapper	getWrapperFor(String optionId)
void	init(InteractionDialogAPI dialog)
void	leaveBar()
void	optionMousedOver(String optionText, Object optionData)
void	optionSelected(String optionText, Object optionData)
void	returningFromEvent(boolean withContinue)
void	returningFromEvent(PortsideBarEvent event)
void	showOptions(boolean returningFromEvent)

Methods inherited from class com.fs.starfarer.api.impl.campaign.rulecmd.BaseCommandPlugin

doesCommandAddOptions, getEntityMemory, getOptionOrder

Methods inherited from class java.lang.Object

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

Field Details

BAR_EVENT_MIN_TIME_BEFORE_CHANGING

public static float BAR_EVENT_MIN_TIME_BEFORE_CHANGING

BAR_EVENT_MAX_TIME_BEFORE_CHANGING

public static float BAR_EVENT_MAX_TIME_BEFORE_CHANGING

entity

protected SectorEntityToken entity

originalPlugin

protected InteractionDialogPlugin originalPlugin

dialog

protected InteractionDialogAPI dialog

memoryMap

protected Map<String,MemoryAPI> memoryMap

Constructor Details

BarCMD

public BarCMD()

Method Details

execute

public boolean execute(String ruleId,
 InteractionDialogAPI dialog,
 List<Misc.Token> params,
 Map<String,MemoryAPI> memoryMap)

Specified by:

execute in interface CommandPlugin

showOptions

public void showOptions(boolean returningFromEvent)

optionSelected

public void optionSelected(String optionText,
 Object optionData)

Specified by:

optionSelected in interface InteractionDialogPlugin

returningFromEvent

public void returningFromEvent(PortsideBarEvent event)

returningFromEvent

public void returningFromEvent(boolean withContinue)

getWrapperFor

public HubMissionBarEventWrapper getWrapperFor(String optionId)

abortMissions

public void abortMissions(String optionId)

getAmbiencePlayer

public static BarCMD.BarAmbiencePlayer getAmbiencePlayer()

leaveBar

public void leaveBar()

advance

public void advance(float amount)

Specified by:

advance in interface InteractionDialogPlugin

backFromEngagement

public void backFromEngagement(EngagementResultAPI battleResult)

Specified by:

backFromEngagement in interface InteractionDialogPlugin

getContext

public Object getContext()

Specified by:

getContext in interface InteractionDialogPlugin

getMemoryMap

public Map<String,MemoryAPI> getMemoryMap()

Specified by:

getMemoryMap in interface InteractionDialogPlugin

optionMousedOver

public void optionMousedOver(String optionText,
 Object optionData)

Specified by:

optionMousedOver in interface InteractionDialogPlugin

init

public void init(InteractionDialogAPI dialog)

Specified by:

init in interface InteractionDialogPlugin