com.fs.starfarer.api.impl.campaign.rulecmd

Class PaginatedOptions

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.BaseCommandPlugin

com.fs.starfarer.api.impl.campaign.rulecmd.PaginatedOptions

All Implemented Interfaces:

InteractionDialogPlugin, CommandPlugin

Direct Known Subclasses:

PaginatedOptionsExample

public class PaginatedOptions
extends BaseCommandPlugin
implements InteractionDialogPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaginatedOptions.PaginatedOption

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currPage
protected InteractionDialogAPI	dialog
protected java.util.Map<java.lang.String,MemoryAPI>	memoryMap
static java.lang.String	OPTION_NEXT_PAGE
static java.lang.String	OPTION_PREV_PAGE
protected java.util.List<PaginatedOptions.PaginatedOption>	options
protected java.util.List<PaginatedOptions.PaginatedOption>	optionsAllPages
protected int	optionsPerPage
protected InteractionDialogPlugin	originalPlugin
protected boolean	withSpacers

Constructor Summary

Constructors

Constructor and Description
PaginatedOptions()

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String text, java.lang.String id)
void	addOptionAllPages(java.lang.String text, java.lang.String id)
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)
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.
java.lang.String	getNextPageText()
java.lang.String	getPreviousPageText()
void	init(InteractionDialogAPI dialog) Initialize your GUI in here, by populating options, texts and images *
boolean	isNewGameDialog()
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	showOptions()

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

OPTION_NEXT_PAGE

public static java.lang.String OPTION_NEXT_PAGE

OPTION_PREV_PAGE

public static java.lang.String OPTION_PREV_PAGE

originalPlugin

protected InteractionDialogPlugin originalPlugin

dialog

protected InteractionDialogAPI dialog

memoryMap

protected java.util.Map<java.lang.String,MemoryAPI> memoryMap

options

protected java.util.List<PaginatedOptions.PaginatedOption> options

optionsAllPages

protected java.util.List<PaginatedOptions.PaginatedOption> optionsAllPages

optionsPerPage

protected int optionsPerPage

currPage

protected int currPage

withSpacers

protected boolean withSpacers

Constructor Detail

PaginatedOptions

public PaginatedOptions()

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

addOption

public void addOption(java.lang.String text,
                      java.lang.String id)

addOptionAllPages

public void addOptionAllPages(java.lang.String text,
                              java.lang.String id)

showOptions

public void showOptions()

getPreviousPageText

public java.lang.String getPreviousPageText()

getNextPageText

public java.lang.String getNextPageText()

isNewGameDialog

public boolean isNewGameDialog()

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.

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