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 and Description
static class	BarCMD.BarAmbiencePlayer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BarCMD()

Method Summary

Modifier and Type	Method and Description
void	abortMissions(java.lang.String optionId)
void	advance(float amount) Get's called every frame.
void	backFromEngagement(EngagementResultAPI battleResult) Get's called after a fleet battle connected to this dialog ends.
boolean	execute(java.lang.String ruleId, InteractionDialogAPI dialog, java.util.List<Misc.Token> params, java.util.Map<java.lang.String,MemoryAPI> memoryMap)
static BarCMD.BarAmbiencePlayer	getAmbiencePlayer()
java.lang.Object	getContext() Usually, simply returning null is fine
java.util.Map<java.lang.String,MemoryAPI>	getMemoryMap() Usually, simply returning null or an empty map is fine.
HubMissionBarEventWrapper	getWrapperFor(java.lang.String optionId)
void	init(InteractionDialogAPI dialog) Initialize your GUI in here, by populating options, texts and images *
void	leaveBar()
void	optionMousedOver(java.lang.String optionText, java.lang.Object optionData) Get's called when the player hovers over an option.
void	optionSelected(java.lang.String optionText, java.lang.Object optionData) This gets called when the player clicks on an option.
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 Detail

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 java.util.Map<java.lang.String,MemoryAPI> memoryMap

Constructor Detail

BarCMD

public BarCMD()

Method Detail

execute

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

Specified by:

execute in interface CommandPlugin

showOptions

public void showOptions(boolean returningFromEvent)

optionSelected

public void optionSelected(java.lang.String optionText,
                           java.lang.Object optionData)

Description copied from interface: InteractionDialogPlugin

This gets called when the player clicks on an option. Execute the logic for the selected option in here

Specified by:

optionSelected in interface InteractionDialogPlugin

Parameters:

optionText - the name of the option, i.e. the first argument passed to addOption

optionData - the data/identifier of the selected option. Cast this to the correct type. Don't forget to null-check the result of the cast.

returningFromEvent

public void returningFromEvent(PortsideBarEvent event)

returningFromEvent

public void returningFromEvent(boolean withContinue)

getWrapperFor

public HubMissionBarEventWrapper getWrapperFor(java.lang.String optionId)

abortMissions

public void abortMissions(java.lang.String optionId)

getAmbiencePlayer

public static BarCMD.BarAmbiencePlayer getAmbiencePlayer()

leaveBar

public void leaveBar()

advance

public void advance(float amount)

Description copied from interface: InteractionDialogPlugin

Get's called every frame. Can usually be left empty.

Specified by:

advance in interface InteractionDialogPlugin

backFromEngagement

public void backFromEngagement(EngagementResultAPI battleResult)

Description copied from interface: InteractionDialogPlugin

Get's called after a fleet battle connected to this dialog ends. Can be left empty if the dialog you are implementing isn't related to a fleet battle. This documentation is incomplete.

Specified by:

backFromEngagement in interface InteractionDialogPlugin

getContext

public java.lang.Object getContext()

Description copied from interface: InteractionDialogPlugin

Usually, simply returning null is fine

Specified by:

getContext in interface InteractionDialogPlugin

Returns:

the context, e.g. campaign entity or fleet or other thing that was interacted with to spawn this dialog *

getMemoryMap

public java.util.Map<java.lang.String,MemoryAPI> getMemoryMap()

Description copied from interface: InteractionDialogPlugin

Usually, simply returning null or an empty map is fine.

Specified by:

getMemoryMap in interface InteractionDialogPlugin

Returns:

a map that maps string keys to memory entries. Only relevant if you want to interact with rulescmd (I think)

optionMousedOver

public void optionMousedOver(java.lang.String optionText,
                             java.lang.Object optionData)

Description copied from interface: InteractionDialogPlugin

Get's called when the player hovers over an option. Can usually be left empty.

Specified by:

optionMousedOver in interface InteractionDialogPlugin

init

public void init(InteractionDialogAPI dialog)

Description copied from interface: InteractionDialogPlugin

Initialize your GUI in here, by populating options, texts and images *

Specified by:

init in interface InteractionDialogPlugin

Parameters:

dialog - entry point for interacting with the dialog. You should probably store this in a member variable