Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.plugins.SimulatorPlugin Interface Reference
Inheritance diagram for com.fs.starfarer.api.plugins.SimulatorPlugin:
[legend]

Classes

interface  AdvancedSimOption
 
class  SimCategoryData
 
class  SimOptionCheckboxData
 
class  SimOptionData
 
class  SimOptionSelectorData
 
class  SimUIStateData
 

Public Member Functions

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

Static Public Attributes

static boolean ENABLE_OPTION_CHECKBOX_ICONS = true
 
static float DEFAULT_PAD_AFTER = 20f
 

Detailed Description

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

Definition at line 28 of file SimulatorPlugin.java.

Member Function Documentation

◆ addCustomOpponents()

void com.fs.starfarer.api.plugins.SimulatorPlugin.addCustomOpponents ( List< String > variants)

◆ appendToTooltip()

void com.fs.starfarer.api.plugins.SimulatorPlugin.appendToTooltip ( TooltipMakerAPI info,
float initPad,
float width,
AdvancedSimOption option,
Object extra )

◆ applySettingsToDeployed()

void com.fs.starfarer.api.plugins.SimulatorPlugin.applySettingsToDeployed ( List< DeployedFleetMemberAPI > deployed,
Map< String, String > settings )

◆ applySettingsToFleetMembers()

void com.fs.starfarer.api.plugins.SimulatorPlugin.applySettingsToFleetMembers ( List< FleetMemberAPI > members,
SimCategoryData category,
Map< String, String > settings )

◆ generateSelection()

List< String > com.fs.starfarer.api.plugins.SimulatorPlugin.generateSelection ( SimCategoryData category,
int deploymentPoints )

◆ getCategories()

List< SimCategoryData > com.fs.starfarer.api.plugins.SimulatorPlugin.getCategories ( )

◆ getCustomCategory()

SimCategoryData com.fs.starfarer.api.plugins.SimulatorPlugin.getCustomCategory ( )

◆ getSimOptions()

List< AdvancedSimOption > com.fs.starfarer.api.plugins.SimulatorPlugin.getSimOptions ( SimCategoryData category)

◆ getUIStateData()

SimUIStateData com.fs.starfarer.api.plugins.SimulatorPlugin.getUIStateData ( )

◆ loadCustomOpponents()

void com.fs.starfarer.api.plugins.SimulatorPlugin.loadCustomOpponents ( )

◆ loadUIStateData()

void com.fs.starfarer.api.plugins.SimulatorPlugin.loadUIStateData ( )

◆ removeCustomOpponents()

void com.fs.starfarer.api.plugins.SimulatorPlugin.removeCustomOpponents ( List< String > variants)

◆ reportPlayerBattleOccurred()

void com.fs.starfarer.api.plugins.SimulatorPlugin.reportPlayerBattleOccurred ( CampaignFleetAPI primaryWinner,
BattleAPI battle )

◆ resetToDefaults()

void com.fs.starfarer.api.plugins.SimulatorPlugin.resetToDefaults ( boolean withSave)

◆ saveCustomOpponents()

void com.fs.starfarer.api.plugins.SimulatorPlugin.saveCustomOpponents ( )

◆ saveUIStateData()

void com.fs.starfarer.api.plugins.SimulatorPlugin.saveUIStateData ( )

◆ showGroupDeploymentWidget()

boolean com.fs.starfarer.api.plugins.SimulatorPlugin.showGroupDeploymentWidget ( SimCategoryData category)

Member Data Documentation

◆ DEFAULT_PAD_AFTER

float com.fs.starfarer.api.plugins.SimulatorPlugin.DEFAULT_PAD_AFTER = 20f
static

Definition at line 32 of file SimulatorPlugin.java.

◆ ENABLE_OPTION_CHECKBOX_ICONS

boolean com.fs.starfarer.api.plugins.SimulatorPlugin.ENABLE_OPTION_CHECKBOX_ICONS = true
static

Definition at line 30 of file SimulatorPlugin.java.


The documentation for this interface was generated from the following file: