com.fs.starfarer.api.impl.campaign

Class JumpPointInteractionDialogPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.campaign.JumpPointInteractionDialogPluginImpl

All Implemented Interfaces:

InteractionDialogPlugin

public class JumpPointInteractionDialogPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fs.starfarer.api.impl.campaign.JumpPointInteractionDialogPluginImpl.OptionId	beingConfirmed
static java.lang.String	CAN_STABILIZE
protected boolean	canAfford
protected float	fuelCost
protected com.fs.starfarer.api.impl.campaign.JumpPointInteractionDialogPluginImpl.OptionId	lastOptionMousedOver
protected boolean	shownConfirm
static java.lang.String	UNSTABLE_KEY
static float	WORMHOLE_FUEL_USE_MULT

Constructor Summary

Constructors

Constructor and Description
JumpPointInteractionDialogPluginImpl()

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.
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 *
boolean	isWormhole()
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.
protected void	showWarningIfNeeded()

Methods inherited from class java.lang.Object

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

Field Detail

UNSTABLE_KEY

public static final java.lang.String UNSTABLE_KEY

See Also:

Constant Field Values

CAN_STABILIZE

public static final java.lang.String CAN_STABILIZE

See Also:

Constant Field Values

WORMHOLE_FUEL_USE_MULT

public static float WORMHOLE_FUEL_USE_MULT

shownConfirm

protected boolean shownConfirm

canAfford

protected boolean canAfford

beingConfirmed

protected com.fs.starfarer.api.impl.campaign.JumpPointInteractionDialogPluginImpl.OptionId beingConfirmed

lastOptionMousedOver

protected com.fs.starfarer.api.impl.campaign.JumpPointInteractionDialogPluginImpl.OptionId lastOptionMousedOver

fuelCost

protected float fuelCost

Constructor Detail

JumpPointInteractionDialogPluginImpl

public JumpPointInteractionDialogPluginImpl()

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

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.

showWarningIfNeeded

protected void showWarningIfNeeded()

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 *

isWormhole

public boolean isWormhole()