Package com.fs.starfarer.api.plugins

Interface SimulatorPlugin

All Known Implementing Classes:

SimulatorPluginImpl

public interface SimulatorPlugin

Implementations of this need to handle some campaign events but to also work outside the campaign, e.g. for the devMode "edit variants" simulator, and for the mission refit simulator.

Author:

Alex Copyright 2024 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SimulatorPlugin.AdvancedSimOption
static class	SimulatorPlugin.SimCategoryData
static class	SimulatorPlugin.SimOptionCheckboxData
static class	SimulatorPlugin.SimOptionData
static class	SimulatorPlugin.SimOptionSelectorData
static class	SimulatorPlugin.SimUIStateData

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_PAD_AFTER
static final boolean	ENABLE_OPTION_CHECKBOX_ICONS

Method Summary

Modifier and Type	Method	Description
void	addCustomOpponents(List<String> variants)
void	appendToTooltip(TooltipMakerAPI info, float initPad, float width, SimulatorPlugin.AdvancedSimOption option, Object extra)
void	applySettingsToDeployed(List<DeployedFleetMemberAPI> deployed, Map<String,String> settings)
void	applySettingsToFleetMembers(List<FleetMemberAPI> members, SimulatorPlugin.SimCategoryData category, Map<String,String> settings)
List<String>	generateSelection(SimulatorPlugin.SimCategoryData category, int deploymentPoints)
List<SimulatorPlugin.SimCategoryData>	getCategories()
SimulatorPlugin.SimCategoryData	getCustomCategory()
List<SimulatorPlugin.AdvancedSimOption>	getSimOptions(SimulatorPlugin.SimCategoryData category)
SimulatorPlugin.SimUIStateData	getUIStateData()
void	loadCustomOpponents()
void	loadUIStateData()
void	removeCustomOpponents(List<String> variants)
void	reportPlayerBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	resetToDefaults(boolean withSave)
void	saveCustomOpponents()
void	saveUIStateData()
boolean	showGroupDeploymentWidget(SimulatorPlugin.SimCategoryData category)

Field Details

ENABLE_OPTION_CHECKBOX_ICONS

static final boolean ENABLE_OPTION_CHECKBOX_ICONS

See Also:

• Constant Field Values

DEFAULT_PAD_AFTER

static final float DEFAULT_PAD_AFTER

See Also:

• Constant Field Values

Method Details

applySettingsToFleetMembers

void applySettingsToFleetMembers(List<FleetMemberAPI> members,
 SimulatorPlugin.SimCategoryData category,
 Map<String,String> settings)

applySettingsToDeployed

void applySettingsToDeployed(List<DeployedFleetMemberAPI> deployed,
 Map<String,String> settings)

getCategories

List<SimulatorPlugin.SimCategoryData> getCategories()

getCustomCategory

SimulatorPlugin.SimCategoryData getCustomCategory()

getSimOptions

List<SimulatorPlugin.AdvancedSimOption> getSimOptions(SimulatorPlugin.SimCategoryData category)

showGroupDeploymentWidget

boolean showGroupDeploymentWidget(SimulatorPlugin.SimCategoryData category)

getUIStateData

SimulatorPlugin.SimUIStateData getUIStateData()

loadUIStateData

void loadUIStateData()

saveUIStateData

void saveUIStateData()

addCustomOpponents

void addCustomOpponents(List<String> variants)

removeCustomOpponents

void removeCustomOpponents(List<String> variants)

loadCustomOpponents

void loadCustomOpponents()

saveCustomOpponents

void saveCustomOpponents()

generateSelection

List<String> generateSelection(SimulatorPlugin.SimCategoryData category,
 int deploymentPoints)

reportPlayerBattleOccurred

void reportPlayerBattleOccurred(CampaignFleetAPI primaryWinner,
 BattleAPI battle)

appendToTooltip

void appendToTooltip(TooltipMakerAPI info,
 float initPad,
 float width,
 SimulatorPlugin.AdvancedSimOption option,
 Object extra)

resetToDefaults

void resetToDefaults(boolean withSave)