com.fs.starfarer.api.impl.campaign.intel.punitive

Class PEAvertInteractionDialogPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.campaign.intel.punitive.PEAvertInteractionDialogPluginImpl

All Implemented Interfaces:

InteractionDialogPlugin

public class PEAvertInteractionDialogPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fs.starfarer.api.impl.campaign.intel.punitive.PEAvertInteractionDialogPluginImpl.OptionId	beingConfirmed
static int	BRIBE_MAX
static int	BRIBE_MULT
protected InteractionDialogAPI	dialog
protected PunitiveExpeditionIntel	intel
static RepLevel	MIN_REP
protected OptionPanelAPI	options
protected CampaignFleetAPI	playerFleet
static float	REP_COST
protected TextPanelAPI	textPanel
protected IntelUIAPI	ui
protected VisualPanelAPI	visual

Constructor Summary

Constructors

Constructor and Description
PEAvertInteractionDialogPluginImpl(PunitiveExpeditionIntel intel, IntelUIAPI ui)

Method Summary

Modifier and Type	Method and Description
protected void	addChoiceOptions()
protected void	addConfirmOptions()
protected void	addDismissOption()
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.
protected int	computeBribeAmount()
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.
void	init(InteractionDialogAPI dialog) Initialize your GUI in here, by populating options, texts and images *
protected void	leave()
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	printInit()
protected void	printOptionDesc(com.fs.starfarer.api.impl.campaign.intel.punitive.PEAvertInteractionDialogPluginImpl.OptionId option)

Methods inherited from class java.lang.Object

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

Field Detail

BRIBE_MULT

public static int BRIBE_MULT

BRIBE_MAX

public static int BRIBE_MAX

MIN_REP

public static RepLevel MIN_REP

REP_COST

public static float REP_COST

dialog

protected InteractionDialogAPI dialog

textPanel

protected TextPanelAPI textPanel

options

protected OptionPanelAPI options

visual

protected VisualPanelAPI visual

playerFleet

protected CampaignFleetAPI playerFleet

intel

protected PunitiveExpeditionIntel intel

ui

protected IntelUIAPI ui

beingConfirmed

protected com.fs.starfarer.api.impl.campaign.intel.punitive.PEAvertInteractionDialogPluginImpl.OptionId beingConfirmed

Constructor Detail

PEAvertInteractionDialogPluginImpl

public PEAvertInteractionDialogPluginImpl(PunitiveExpeditionIntel intel,
                                          IntelUIAPI ui)

Method Detail

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

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)

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

computeBribeAmount

protected int computeBribeAmount()

printOptionDesc

protected void printOptionDesc(com.fs.starfarer.api.impl.campaign.intel.punitive.PEAvertInteractionDialogPluginImpl.OptionId option)

addChoiceOptions

protected void addChoiceOptions()

addDismissOption

protected void addDismissOption()

addConfirmOptions

protected void addConfirmOptions()

printInit

public void printInit()

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.

leave

protected void leave()

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 *