com.fs.starfarer.api.impl.campaign.tutorial

Class TutorialWelcomeDialogPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.campaign.tutorial.TutorialWelcomeDialogPluginImpl

All Implemented Interfaces:

InteractionDialogPlugin

public class TutorialWelcomeDialogPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TutorialWelcomeDialogPluginImpl.OptionId

Field Summary

Fields

Modifier and Type	Field and Description
protected InteractionDialogAPI	dialog
protected OptionPanelAPI	options
protected CampaignFleetAPI	playerFleet
protected TextPanelAPI	textPanel
protected VisualPanelAPI	visual

Constructor Summary

Constructors

Constructor and Description
TutorialWelcomeDialogPluginImpl()

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

Methods inherited from class java.lang.Object

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

Field Detail

dialog

protected InteractionDialogAPI dialog

textPanel

protected TextPanelAPI textPanel

options

protected OptionPanelAPI options

visual

protected VisualPanelAPI visual

playerFleet

protected CampaignFleetAPI playerFleet

Constructor Detail

TutorialWelcomeDialogPluginImpl

public TutorialWelcomeDialogPluginImpl()

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.

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 *