com.fs.starfarer.api.impl.campaign

Class FleetInteractionDialogPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.campaign.FleetInteractionDialogPluginImpl

All Implemented Interfaces:

InteractionDialogPlugin, RuleBasedDialog

public class FleetInteractionDialogPluginImpl
extends java.lang.Object
implements InteractionDialogPlugin, RuleBasedDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FleetInteractionDialogPluginImpl.BaseFIDDelegate
static class	FleetInteractionDialogPluginImpl.FIDConfig
static interface	FleetInteractionDialogPluginImpl.FIDConfigGen
static interface	FleetInteractionDialogPluginImpl.FIDDelegate
static class	FleetInteractionDialogPluginImpl.OptionId
protected static class	FleetInteractionDialogPluginImpl.VisualType

Field Summary

Fields

Modifier and Type	Field and Description
protected CampaignFleetAIAPI.InitialBoardingResponse	aiBoardingResponse
protected boolean	allyEngagementChoiceNoBattle
protected CrewCompositionAPI	boardingParty
protected float	boardingPercentSuccess
protected int	boardingPhase
protected FleetEncounterContext.BoardingResult	boardingResult
protected boolean	cleanedUp
protected FleetInteractionDialogPluginImpl.FIDConfig	config
protected FleetEncounterContext	context
protected RuleBasedInteractionDialogPluginImpl	conversationDelegate
protected java.lang.String	crashMothballList
protected java.lang.String	creditsLooted
protected FleetInteractionDialogPluginImpl.VisualType	currVisualType
protected InteractionDialogAPI	dialog
protected boolean	didBoardingCheck
protected boolean	didRecoveryCheck
protected boolean	didRepairs
static boolean	directToComms
static java.lang.String	DO_NOT_AUTO_SHOW_FC_PORTRAIT
static float	EMERGENCY_REPAIRS_MAX_DP
protected static java.awt.Color	ENEMY_COLOR
protected boolean	firedVictoryTriggers
protected boolean	firstEngagement
protected boolean	forceEngage
protected static java.awt.Color	FRIEND_COLOR
protected boolean	harryEndedBattle
protected static java.awt.Color	HIGHLIGHT_COLOR
static boolean	inConversation
protected boolean	joinedBattle
protected FleetInteractionDialogPluginImpl.OptionId	lastOptionMousedOver
protected EngagementResultAPI	lastResult
protected boolean	lootedCredits
protected CrewCompositionAPI	maxBoardingParty
protected java.util.List<FleetMemberAPI>	membersInOrderPreEncounter
protected boolean	okToLeave
protected boolean	ongoingBattle
protected OptionPanelAPI	options
protected java.util.Map<FleetMemberAPI,PersonAPI>	origCaptains
protected FleetMemberAPI	origFlagship
protected CampaignFleetAPI	otherFleet
protected FleetGoal	otherGoal
protected boolean	pickedMemberToBoard
protected CampaignFleetAPI	playerFleet
protected FleetGoal	playerGoal
protected java.util.List<CampaignFleetAPI>	pulledIn
protected boolean	recoveredCrew
protected java.lang.String	repairedShipList
protected FleetMemberAPI	selectedFlagship
protected boolean	shownKnownStatus
protected boolean	shownTooLargeToRetreatMessage
protected TextPanelAPI	textPanel
protected FleetMemberAPI	toBoard
protected VisualPanelAPI	visual

Constructor Summary

Constructors

Constructor and Description
FleetInteractionDialogPluginImpl()
FleetInteractionDialogPluginImpl(FleetInteractionDialogPluginImpl.FIDConfig params)

Method Summary

Modifier and Type	Method and Description
protected void	addEmergencyRepairsOption()
protected void	addPostBattleAttitudeText()
protected void	addText(java.lang.String text)
protected void	addText(java.lang.String text, java.awt.Color color)
protected void	addText(java.lang.String text, java.lang.String hl, java.awt.Color hlColor)
void	advance(float amount) Get's called every frame.
protected boolean	alliedCanDisengage()
protected boolean	alliedFleetHoldingVsStrongerEnemy()
protected boolean	alliedFleetWantsToDisengage()
boolean	alliedFleetWantsToFight()
protected void	appendText(java.lang.String text)
void	backFromEngagement(EngagementResultAPI result) Get's called after a fleet battle connected to this dialog ends.
static boolean	canDisengage()
protected boolean	canDisengageCleanly(CampaignFleetAPI fleet)
protected boolean	canDisengageWithoutPursuit(CampaignFleetAPI fleet)
void	cleanUpBattle()
protected java.lang.String	createShipNameListString(java.util.List<FleetMemberAPI> members)
protected boolean	didEnoughToDisengage(CampaignFleetAPI fleet)
protected boolean	fleetCanDisengage(CampaignFleetAPI fleet)
protected boolean	fleetHoldingVsStrongerEnemy(CampaignFleetAPI fleet, CampaignFleetAPI other)
protected boolean	fleetWantsToDisengage(CampaignFleetAPI fleet, CampaignFleetAPI other)
protected boolean	fleetWantsToFight(CampaignFleetAPI fleet, CampaignFleetAPI other)
protected boolean	fleetWantsToFight(CampaignFleetAPI fleet, CampaignFleetAPI other, boolean assumeHostile)
protected java.lang.String	getApproximate(float value)
protected java.lang.String	getApproximateNumOnly(float value)
java.lang.Object	getContext() Usually, simply returning null is fine
protected java.util.List<FleetMemberAPI>	getCrashMothballable(java.util.List<FleetMemberAPI> all)
static float	getDisengageSize()
protected java.lang.String	getIntOrNo(float value)
java.util.Map<java.lang.String,MemoryAPI>	getMemoryMap() Usually, simply returning null or an empty map is fine.
FactionAPI	getNonHostileOtherFaction()
FactionAPI	getNonHostileOtherFaction(java.util.List<CampaignFleetAPI> otherSide)
protected FleetEncounterContextPlugin.PursueAvailability	getPursuitAvailability(CampaignFleetAPI fleet)
java.util.List<FleetMemberAPI>	getPursuitCapablePlayerShips()
protected java.lang.String	getString(java.lang.String id)
protected void	goToEncounterEndPath()
void	init(InteractionDialogAPI dialog) Initialize your GUI in here, by populating options, texts and images *
protected boolean	isFightingOver()
protected boolean	isValidTransferCommandTarget(FleetMemberAPI member)
protected void	losingPath()
void	notifyActivePersonChanged()
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 boolean	otherCanDisengage()
protected boolean	otherFleetHoldingVsStrongerEnemy()
protected boolean	otherFleetWantsToDisengage()
boolean	otherFleetWantsToFight()
boolean	otherFleetWantsToFight(boolean assumeHostile)
protected CampaignFleetAIAPI.PursuitOption	pickPursuitOption(CampaignFleetAPI fleet, CampaignFleetAPI other, FleetEncounterContext context)
protected boolean	playerOutBeforeAllies()
void	printOngoingBattleInfo()
protected void	pullInNearbyFleets()
void	reinit(boolean withContinueOnRuleFound)
void	reinitPostContinue()
protected void	rememberWasBeaten()
protected void	restoreOrigCaptains()
void	setActiveMission(CampaignEventPlugin mission)
void	setPlayerFleet(CampaignFleetAPI playerFleet)
protected void	showFleetInfo()
protected void	updateDialogState()
protected void	updateEngagementChoice(boolean withText)
protected void	updateMainState(boolean withText)
void	updateMemory()
protected void	updatePreCombat()
protected void	winningPath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMERGENCY_REPAIRS_MAX_DP

public static float EMERGENCY_REPAIRS_MAX_DP

DO_NOT_AUTO_SHOW_FC_PORTRAIT

public static java.lang.String DO_NOT_AUTO_SHOW_FC_PORTRAIT

dialog

protected InteractionDialogAPI dialog

textPanel

protected TextPanelAPI textPanel

options

protected OptionPanelAPI options

visual

protected VisualPanelAPI visual

playerFleet

protected CampaignFleetAPI playerFleet

otherFleet

protected CampaignFleetAPI otherFleet

playerGoal

protected FleetGoal playerGoal

otherGoal

protected FleetGoal otherGoal

currVisualType

protected FleetInteractionDialogPluginImpl.VisualType currVisualType

context

protected FleetEncounterContext context

HIGHLIGHT_COLOR

protected static final java.awt.Color HIGHLIGHT_COLOR

FRIEND_COLOR

protected static final java.awt.Color FRIEND_COLOR

ENEMY_COLOR

protected static final java.awt.Color ENEMY_COLOR

conversationDelegate

protected RuleBasedInteractionDialogPluginImpl conversationDelegate

ongoingBattle

protected boolean ongoingBattle

firstEngagement

protected boolean firstEngagement

joinedBattle

protected boolean joinedBattle

forceEngage

protected boolean forceEngage

shownTooLargeToRetreatMessage

protected boolean shownTooLargeToRetreatMessage

inConversation

public static boolean inConversation

directToComms

public static boolean directToComms

config

protected FleetInteractionDialogPluginImpl.FIDConfig config

membersInOrderPreEncounter

protected java.util.List<FleetMemberAPI> membersInOrderPreEncounter

pulledIn

protected java.util.List<CampaignFleetAPI> pulledIn

lastResult

protected EngagementResultAPI lastResult

cleanedUp

protected boolean cleanedUp

okToLeave

protected boolean okToLeave

didRepairs

protected boolean didRepairs

didBoardingCheck

protected boolean didBoardingCheck

didRecoveryCheck

protected boolean didRecoveryCheck

pickedMemberToBoard

protected boolean pickedMemberToBoard

toBoard

protected FleetMemberAPI toBoard

repairedShipList

protected java.lang.String repairedShipList

boardingPhase

protected int boardingPhase

boardingPercentSuccess

protected float boardingPercentSuccess

crashMothballList

protected java.lang.String crashMothballList

maxBoardingParty

protected CrewCompositionAPI maxBoardingParty

boardingParty

protected CrewCompositionAPI boardingParty

boardingResult

protected FleetEncounterContext.BoardingResult boardingResult

selectedFlagship

protected FleetMemberAPI selectedFlagship

origFlagship

protected FleetMemberAPI origFlagship

origCaptains

protected java.util.Map<FleetMemberAPI,PersonAPI> origCaptains

aiBoardingResponse

protected CampaignFleetAIAPI.InitialBoardingResponse aiBoardingResponse

shownKnownStatus

protected boolean shownKnownStatus

recoveredCrew

protected boolean recoveredCrew

lootedCredits

protected boolean lootedCredits

firedVictoryTriggers

protected boolean firedVictoryTriggers

creditsLooted

protected java.lang.String creditsLooted

lastOptionMousedOver

protected FleetInteractionDialogPluginImpl.OptionId lastOptionMousedOver

allyEngagementChoiceNoBattle

protected boolean allyEngagementChoiceNoBattle

harryEndedBattle

protected boolean harryEndedBattle

Constructor Detail

FleetInteractionDialogPluginImpl

public FleetInteractionDialogPluginImpl()

FleetInteractionDialogPluginImpl

public FleetInteractionDialogPluginImpl(FleetInteractionDialogPluginImpl.FIDConfig params)

Method Detail

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

Specified by:

getMemoryMap in interface RuleBasedDialog

Returns:

a map that maps string keys to memory entries. Only relevant if you want to interact with rulescmd (I think)

reinit

public void reinit(boolean withContinueOnRuleFound)

Specified by:

reinit in interface RuleBasedDialog

reinitPostContinue

public void reinitPostContinue()

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

printOngoingBattleInfo

public void printOngoingBattleInfo()

pullInNearbyFleets

protected void pullInNearbyFleets()

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

addPostBattleAttitudeText

protected void addPostBattleAttitudeText()

getPursuitCapablePlayerShips

public java.util.List<FleetMemberAPI> getPursuitCapablePlayerShips()

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.

rememberWasBeaten

protected void rememberWasBeaten()

restoreOrigCaptains

protected void restoreOrigCaptains()

cleanUpBattle

public void cleanUpBattle()

goToEncounterEndPath

protected void goToEncounterEndPath()

losingPath

protected void losingPath()

winningPath

protected void winningPath()

getCrashMothballable

protected java.util.List<FleetMemberAPI> getCrashMothballable(java.util.List<FleetMemberAPI> all)

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

showFleetInfo

protected void showFleetInfo()

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

addText

protected void addText(java.lang.String text)

addText

protected void addText(java.lang.String text,
                       java.awt.Color color)

addText

protected void addText(java.lang.String text,
                       java.lang.String hl,
                       java.awt.Color hlColor)

appendText

protected void appendText(java.lang.String text)

updateDialogState

protected void updateDialogState()

isValidTransferCommandTarget

protected boolean isValidTransferCommandTarget(FleetMemberAPI member)

updatePreCombat

protected void updatePreCombat()

createShipNameListString

protected java.lang.String createShipNameListString(java.util.List<FleetMemberAPI> members)

updateMainState

protected void updateMainState(boolean withText)

updateEngagementChoice

protected void updateEngagementChoice(boolean withText)

addEmergencyRepairsOption

protected void addEmergencyRepairsOption()

pickPursuitOption

protected CampaignFleetAIAPI.PursuitOption pickPursuitOption(CampaignFleetAPI fleet,
                                                             CampaignFleetAPI other,
                                                             FleetEncounterContext context)

getNonHostileOtherFaction

public FactionAPI getNonHostileOtherFaction()

getNonHostileOtherFaction

public FactionAPI getNonHostileOtherFaction(java.util.List<CampaignFleetAPI> otherSide)

playerOutBeforeAllies

protected boolean playerOutBeforeAllies()

canDisengage

public static boolean canDisengage()

otherCanDisengage

protected boolean otherCanDisengage()

alliedCanDisengage

protected boolean alliedCanDisengage()

fleetCanDisengage

protected boolean fleetCanDisengage(CampaignFleetAPI fleet)

getDisengageSize

public static float getDisengageSize()

didEnoughToDisengage

protected boolean didEnoughToDisengage(CampaignFleetAPI fleet)

canDisengageCleanly

protected boolean canDisengageCleanly(CampaignFleetAPI fleet)

canDisengageWithoutPursuit

protected boolean canDisengageWithoutPursuit(CampaignFleetAPI fleet)

getPursuitAvailability

protected FleetEncounterContextPlugin.PursueAvailability getPursuitAvailability(CampaignFleetAPI fleet)

getString

protected java.lang.String getString(java.lang.String id)

getIntOrNo

protected java.lang.String getIntOrNo(float value)

getApproximate

protected java.lang.String getApproximate(float value)

getApproximateNumOnly

protected java.lang.String getApproximateNumOnly(float value)

isFightingOver

protected boolean isFightingOver()

alliedFleetWantsToFight

public boolean alliedFleetWantsToFight()

otherFleetWantsToFight

public boolean otherFleetWantsToFight()

otherFleetWantsToFight

public boolean otherFleetWantsToFight(boolean assumeHostile)

fleetWantsToFight

protected boolean fleetWantsToFight(CampaignFleetAPI fleet,
                                    CampaignFleetAPI other)

fleetWantsToFight

protected boolean fleetWantsToFight(CampaignFleetAPI fleet,
                                    CampaignFleetAPI other,
                                    boolean assumeHostile)

alliedFleetHoldingVsStrongerEnemy

protected boolean alliedFleetHoldingVsStrongerEnemy()

otherFleetHoldingVsStrongerEnemy

protected boolean otherFleetHoldingVsStrongerEnemy()

fleetHoldingVsStrongerEnemy

protected boolean fleetHoldingVsStrongerEnemy(CampaignFleetAPI fleet,
                                              CampaignFleetAPI other)

alliedFleetWantsToDisengage

protected boolean alliedFleetWantsToDisengage()

otherFleetWantsToDisengage

protected boolean otherFleetWantsToDisengage()

fleetWantsToDisengage

protected boolean fleetWantsToDisengage(CampaignFleetAPI fleet,
                                        CampaignFleetAPI other)

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 *

updateMemory

public void updateMemory()

Specified by:

updateMemory in interface RuleBasedDialog

notifyActivePersonChanged

public void notifyActivePersonChanged()

Specified by:

notifyActivePersonChanged in interface RuleBasedDialog

setActiveMission

public void setActiveMission(CampaignEventPlugin mission)

Specified by:

setActiveMission in interface RuleBasedDialog

setPlayerFleet

public void setPlayerFleet(CampaignFleetAPI playerFleet)