Package 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	Description
static class	PaginatedOptions.PaginatedOption

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
PaginatedOptions()

Method Summary

Modifier and Type	Method	Description
void	addOption(String text, String id)
void	addOptionAllPages(String text, String id)
void	advance(float amount)
void	backFromEngagement(EngagementResultAPI battleResult)
boolean	execute(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)
Object	getContext()
Map<String,MemoryAPI>	getMemoryMap()
String	getNextPageText()
String	getPreviousPageText()
void	init(InteractionDialogAPI dialog)
boolean	isNewGameDialog()
void	optionMousedOver(String optionText, Object optionData)
void	optionSelected(String optionText, Object optionData)
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 Details

OPTION_NEXT_PAGE

public static String OPTION_NEXT_PAGE

OPTION_PREV_PAGE

public static String OPTION_PREV_PAGE

originalPlugin

protected InteractionDialogPlugin originalPlugin

dialog

protected InteractionDialogAPI dialog

memoryMap

protected Map<String,MemoryAPI> memoryMap

options

protected List<PaginatedOptions.PaginatedOption> options

optionsAllPages

protected List<PaginatedOptions.PaginatedOption> optionsAllPages

optionsPerPage

protected int optionsPerPage

currPage

protected int currPage

withSpacers

protected boolean withSpacers

Constructor Details

PaginatedOptions

public PaginatedOptions()

Method Details

execute

public boolean execute(String ruleId,
 InteractionDialogAPI dialog,
 List<Misc.Token> params,
 Map<String,MemoryAPI> memoryMap)

Specified by:

execute in interface CommandPlugin

addOption

public void addOption(String text,
 String id)

addOptionAllPages

public void addOptionAllPages(String text,
 String id)

showOptions

public void showOptions()

getPreviousPageText

public String getPreviousPageText()

getNextPageText

public String getNextPageText()

isNewGameDialog

public boolean isNewGameDialog()

optionSelected

public void optionSelected(String optionText,
 Object optionData)

Specified by:

optionSelected in interface InteractionDialogPlugin

advance

public void advance(float amount)

Specified by:

advance in interface InteractionDialogPlugin

backFromEngagement

public void backFromEngagement(EngagementResultAPI battleResult)

Specified by:

backFromEngagement in interface InteractionDialogPlugin

getContext

public Object getContext()

Specified by:

getContext in interface InteractionDialogPlugin

getMemoryMap

public Map<String,MemoryAPI> getMemoryMap()

Specified by:

getMemoryMap in interface InteractionDialogPlugin

optionMousedOver

public void optionMousedOver(String optionText,
 Object optionData)

Specified by:

optionMousedOver in interface InteractionDialogPlugin

init

public void init(InteractionDialogAPI dialog)

Specified by:

init in interface InteractionDialogPlugin