com.fs.starfarer.api.impl.campaign

Class RuleBasedInteractionDialogPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.campaign.RuleBasedInteractionDialogPluginImpl

All Implemented Interfaces:

InteractionDialogPlugin, RuleBasedDialog

public class RuleBasedInteractionDialogPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin, RuleBasedDialog

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FAILSAFE_LEAVE

Constructor Summary

Constructors

Constructor and Description
RuleBasedInteractionDialogPluginImpl()
RuleBasedInteractionDialogPluginImpl(java.lang.String initialTrigger)

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Get's called every frame.
void	backFromEngagement(EngagementResultAPI result) Get's called after a fleet battle connected to this dialog ends.
boolean	fireAll(java.lang.String trigger)
boolean	fireBest(java.lang.String trigger)
java.lang.Object	getContext() Usually, simply returning null is fine
java.lang.Object	getCustom1()
java.lang.Object	getCustom2()
java.lang.Object	getCustom3()
java.util.Map<java.lang.String,MemoryAPI>	getMemoryMap() Usually, simply returning null or an empty map is fine.
void	init(InteractionDialogAPI dialog) Initialize your GUI in here, by populating options, texts and images *
void	notifyActivePersonChanged()
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 text, java.lang.Object optionData) This gets called when the player clicks on an option.
void	reinit(boolean withContinueOnRuleFound)
void	setActiveMission(CampaignEventPlugin mission)
void	setCustom1(java.lang.Object custom1)
void	setCustom2(java.lang.Object custom2)
void	setCustom3(java.lang.Object custom3)
void	setEmbeddedMode(boolean embeddedMode)
void	updateMemory()

Methods inherited from class java.lang.Object

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

Field Detail

FAILSAFE_LEAVE

public static final java.lang.String FAILSAFE_LEAVE

See Also:

Constant Field Values

Constructor Detail

RuleBasedInteractionDialogPluginImpl

public RuleBasedInteractionDialogPluginImpl()

RuleBasedInteractionDialogPluginImpl

public RuleBasedInteractionDialogPluginImpl(java.lang.String initialTrigger)

Method Detail

setEmbeddedMode

public void setEmbeddedMode(boolean embeddedMode)

reinit

public void reinit(boolean withContinueOnRuleFound)

Specified by:

reinit in interface RuleBasedDialog

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

updateMemory

public void updateMemory()

Specified by:

updateMemory in interface RuleBasedDialog

notifyActivePersonChanged

public void notifyActivePersonChanged()

Specified by:

notifyActivePersonChanged in interface RuleBasedDialog

setActiveMission

public void setActiveMission(CampaignEventPlugin mission)

Specified by:

setActiveMission in interface RuleBasedDialog

fireAll

public boolean fireAll(java.lang.String trigger)

fireBest

public boolean fireBest(java.lang.String trigger)

backFromEngagement

public void backFromEngagement(EngagementResultAPI result)

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

optionSelected

public void optionSelected(java.lang.String text,
                           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:

text - 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.

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

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

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

Specified by:

getMemoryMap in interface RuleBasedDialog

Returns:

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

getCustom1

public java.lang.Object getCustom1()

setCustom1

public void setCustom1(java.lang.Object custom1)

getCustom2

public java.lang.Object getCustom2()

setCustom2

public void setCustom2(java.lang.Object custom2)

getCustom3

public java.lang.Object getCustom3()

setCustom3

public void setCustom3(java.lang.Object custom3)