PlayerFleetGenPluginImpl

java.lang.Object
- com.fs.starfarer.api.impl.campaign.procgen.PlayerFleetGenPluginImpl

All Implemented Interfaces:: InteractionDialogPlugin

public class PlayerFleetGenPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlayerFleetGenPluginImpl.FleetGenData`
`protected static class`	`PlayerFleetGenPluginImpl.FleetQuality`
`protected static class`	`PlayerFleetGenPluginImpl.OptionId`

Field Summary

Fields
Modifier and Type	Field and Description
`protected PlayerFleetGenPluginImpl.FleetGenData`	`data`
`protected InteractionDialogAPI`	`dialog`
`protected java.util.Set<java.lang.String>`	`fighters`
`protected static java.awt.Color`	`HIGHLIGHT_COLOR`
`protected java.util.Set<java.lang.String>`	`hullmods`
`protected PlayerFleetGenPluginImpl.OptionId`	`lastOptionMousedOver`
`protected OptionPanelAPI`	`options`
`protected CampaignFleetAPI`	`playerFleet`
`protected java.util.Set<java.lang.String>`	`ships`
`protected TextPanelAPI`	`textPanel`
`protected java.util.Set<java.lang.String>`	`unrestrictedFighters`
`protected java.util.Set<java.lang.String>`	`unrestrictedWeapons`
`protected VisualPanelAPI`	`visual`
`protected java.util.Set<java.lang.String>`	`weapons`

Constructor Summary

Constructors
Constructor and Description

PlayerFleetGenPluginImpl()

Constructors
Constructor and Description
`PlayerFleetGenPluginImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addNoSkillOfficer(int level)`
`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.
`protected void`	`createFleet()`
`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.
`protected MarketAPI`	`getNearestMarket(boolean playerOnly)`
`void`	`init(InteractionDialogAPI dialog)` Initialize your GUI in here, by populating options, texts and images *
`protected void`	`initAvailable()`
`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.
`protected void`	`print(java.lang.String str)`
`protected void`	`selectAppendOrReplace()`
`protected void`	`selectOfficerLevel()`
`protected void`	`selectQuality()`
`protected void`	`selectShipsAndWeapons()`
`void`	`showBlueprintPicker()`
`protected void`	`showOfficerSelector()`

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
```
  - data
```
protected PlayerFleetGenPluginImpl.FleetGenData data
```
  - playerFleet
```
protected CampaignFleetAPI playerFleet
```
  - ships
```
protected java.util.Set<java.lang.String> ships
```
  - fighters
```
protected java.util.Set<java.lang.String> fighters
```
  - weapons
```
protected java.util.Set<java.lang.String> weapons
```
  - unrestrictedFighters
```
protected java.util.Set<java.lang.String> unrestrictedFighters
```
  - unrestrictedWeapons
```
protected java.util.Set<java.lang.String> unrestrictedWeapons
```
  - hullmods
```
protected java.util.Set<java.lang.String> hullmods
```
  - HIGHLIGHT_COLOR
```
protected static final java.awt.Color HIGHLIGHT_COLOR
```
  - lastOptionMousedOver
```
protected PlayerFleetGenPluginImpl.OptionId lastOptionMousedOver
```
- Constructor Detail
  - PlayerFleetGenPluginImpl
```
public PlayerFleetGenPluginImpl()
```
- 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.
  - getNearestMarket
```
protected MarketAPI getNearestMarket(boolean playerOnly)
```
  - print
```
protected void print(java.lang.String str)
```
  - selectShipsAndWeapons
```
protected void selectShipsAndWeapons()
```
  - showOfficerSelector
```
protected void showOfficerSelector()
```
  - selectQuality
```
protected void selectQuality()
```
  - selectOfficerLevel
```
protected void selectOfficerLevel()
```
  - selectAppendOrReplace
```
protected void selectAppendOrReplace()
```
  - 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 *
  - showBlueprintPicker
```
public void showBlueprintPicker()
```
  - createFleet
```
protected void createFleet()
```
  - initAvailable
```
protected void initAvailable()
```
  - addNoSkillOfficer
```
protected void addNoSkillOfficer(int level)
```

Class PlayerFleetGenPluginImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dialog

textPanel

options

visual

data

playerFleet

ships

fighters

weapons

unrestrictedFighters

unrestrictedWeapons

hullmods

HIGHLIGHT_COLOR

lastOptionMousedOver

Constructor Detail

PlayerFleetGenPluginImpl

Method Detail

init

getMemoryMap

backFromEngagement

optionSelected

getNearestMarket

print

selectShipsAndWeapons

showOfficerSelector

selectQuality

selectOfficerLevel

selectAppendOrReplace

optionMousedOver

advance

getContext

showBlueprintPicker

createFleet

initAvailable

addNoSkillOfficer