com.fs.starfarer.api.impl.campaign.intel.group

Class GenericRaidFGI

java.lang.Object

com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

com.fs.starfarer.api.impl.campaign.intel.group.FleetGroupIntel

com.fs.starfarer.api.impl.campaign.intel.group.GenericRaidFGI

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, RouteManager.RouteFleetSpawner, CallEvent.CallableEvent

Direct Known Subclasses:

BlockadeFGI, PerseanLeaguePunitiveExpedition, SindrianDiktatPunitiveExpedition, TTMercenaryAttack, TTMercenaryReversedAttack

public class GenericRaidFGI
extends FleetGroupIntel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenericRaidFGI.GenericPayloadAction
static class	GenericRaidFGI.GenericRaidParams

Nested classes/interfaces inherited from class com.fs.starfarer.api.impl.campaign.intel.group.FleetGroupIntel

FleetGroupIntel.ETAType, FleetGroupIntel.FGIEventListener

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.comm.IntelInfoPlugin

IntelInfoPlugin.ArrowData, IntelInfoPlugin.IntelSortTier, IntelInfoPlugin.ListInfoMode, IntelInfoPlugin.TableRowClickData

Field Summary

Fields

Modifier and Type	Field and Description
protected SectorEntityToken	origin
protected GenericRaidFGI.GenericRaidParams	params
static java.lang.String	PAYLOAD_ACTION
static java.lang.String	PREPARE_ACTION
protected GenericRaidFGI.GenericPayloadAction	raidAction
static java.lang.String	RETURN_ACTION
protected FGTravelAction	returnAction
static java.lang.String	TRAVEL_ACTION
protected FGTravelAction	travelAction
protected FGWaitAction	waitAction

Fields inherited from class com.fs.starfarer.api.impl.campaign.intel.group.FleetGroupIntel

ABORT_UPDATE, aborted, actions, approximateNumberOfFleets, DEBUG, doIncrementalSpawn, elapsed, faction, failedButNotDefeated, FLEET_LAUNCH_UPDATE, fleetAbortsMissionFPFraction, fleets, groupAbortsMissionFPFraction, KEY_POTENTIAL_STRAGGLER, KEY_SPAWN_FP, KEY_STRAGGLER_RETURN_COUNTDOWN, listener, NEVER_STRAGGLER, prevSegment, random, returnLocation, route, sendFleetLaunchUpdate, sourceWasEverMilitaryMarket, spawnDelay, spawnedFleets, spawning, spawnLocation, totalFPSpawned

Fields inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

BULLET, BUTTON_DELETE, ended, ending, endingTimeRemaining, forceAdd, hidden, important, INDENT, listInfoParam, neverClicked, postingLocation, postingRangeLY, timestamp

Fields inherited from interface com.fs.starfarer.api.campaign.comm.IntelInfoPlugin

LIST_ITEM_TEXT_WIDTH, NEW_DAYS

Constructor Summary

Constructors

Constructor and Description
GenericRaidFGI(GenericRaidFGI.GenericRaidParams params)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAssessmentSection(TooltipMakerAPI info, float width, float height, float opad)
protected void	addBasicDescription(TooltipMakerAPI info, float width, float height, float opad)
protected void	addNonUpdateBulletPoints(TooltipMakerAPI info, java.awt.Color tc, java.lang.Object param, IntelInfoPlugin.ListInfoMode mode, float initPad)
protected void	addPayloadActionStatus(TooltipMakerAPI info, float width, float height, float opad)
protected void	addStatusSection(TooltipMakerAPI info, float width, float height, float opad)
protected void	addTargetingBulletPoint(TooltipMakerAPI info, java.awt.Color tc, java.lang.Object param, IntelInfoPlugin.ListInfoMode mode, float initPad)
protected void	addUpdateBulletPoints(TooltipMakerAPI info, java.awt.Color tc, java.lang.Object param, IntelInfoPlugin.ListInfoMode mode, float initPad)
protected void	configureFleet(int size, CampaignFleetAPI fleet)
protected void	configureFleet(int size, FleetCreatorMission m)
protected CampaignFleetAPI	createFleet(int size, float damage)
protected GenericRaidFGI.GenericPayloadAction	createPayloadAction()
void	doCustomRaidAction(CampaignFleetAPI fleet, MarketAPI market, float raidStr)
static GenericRaidFGI	get(java.lang.String key)
java.util.List<IntelInfoPlugin.ArrowData>	getArrowData(SectorMapAPI map)
protected java.lang.String	getAssessmentRiskStringHighlightOverride()
protected java.lang.String	getAssessmentRiskStringOverride()
java.lang.String	getBaseName()
java.lang.String	getCommMessageSound()
protected SectorEntityToken	getDestination()
protected java.lang.String	getFleetCreationFactionOverride(int size)
java.lang.String	getForcesNoun()
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
SectorEntityToken	getMapLocation(SectorMapAPI map)
java.lang.String	getNoun()
GenericRaidFGI.GenericRaidParams	getParams()
GenericRaidFGI.GenericPayloadAction	getRaidAction()
FGTravelAction	getReturnAction()
protected SectorEntityToken	getSource()
protected StarSystemAPI	getTargetSystem()
FGTravelAction	getTravelAction()
FGWaitAction	getWaitAction()
boolean	hasCustomRaidAction()
protected void	initActions()
boolean	isFailed()
boolean	isPlayerTargeted()
boolean	isSucceeded()
protected void	notifyEnding()
protected void	preConfigureFleet(int size, FleetCreatorMission m)
void	setOrigin(SectorEntityToken origin)
protected boolean	shouldSendIntelUpdateWhenActionFinished(FGAction action)
protected void	spawnFleets()

Methods inherited from class com.fs.starfarer.api.impl.campaign.intel.group.FleetGroupIntel

abort, addAction, addAction, addArrivedBulletPoint, addBulletPoints, addETABulletPoints, addFactionBulletPoint, addStrengthDesc, addStrengthDesc, advance, checkStragglers, computeSampleFleetStrengths, createIntelInfo, createRoute, createSmallDescription, finish, getAction, getActions, getApproximateNumberOfFleets, getApproximateStrengthForTotalDifficultyPoints, getCurrentAction, getDelayRemaining, getElapsed, getETAUntil, getETAUntil, getFaction, getFactionForUIColors, getFailurePostfix, getFleetAbortsMissionFPFraction, getFleets, getGroupAbortsMissionFPFraction, getIcon, getListener, getLocation, getLocationForState, getName, getNameWithNoType, getPotentialStragglerCountdownDays, getRandom, getRelativeFGStrength, getReturnLocation, getRoute, getSegmentForAction, getSmallDescriptionTitle, getSortString, getSortTier, getSuccessPostfix, getTotalFPSpawned, getTravelState, giveFleetsReturnAssignments, giveReturnAssignments, handleIncrementalSpawning, isAborted, isCurrent, isDoIncrementalSpawn, isFailedButNotDefeated, isInPreLaunchDelay, isSourceFunctionalMilitaryMarket, isSpawnedFleets, isSpawning, notifyActionFinished, notifyEnded, pruneDestroyedOrDamagedFleetsAndAbortIfNeeded, readResolve, removeAction, reportAboutToBeDespawnedByRouteManager, setApproximateNumberOfFleets, setDoIncrementalSpawn, setElapsed, setFaction, setFaction, setFailedButNotDefeated, setFleetAbortsMissionFPFraction, setGroupAbortsMissionFPFraction, setListener, setLocationAndCoordinates, setNeverStraggler, setPreFleetDeploymentDelay, setRandom, setReturnLocation, setRoute, setSpawnedFleets, setTotalFPSpawned, shouldAbort, shouldCancelRouteAfterDelayCheck, shouldRepeat, showMarketsInDanger, spawnFleet

Methods inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

addBulletPoints, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addMarketTable, addMarketToList, addMarketToList, advanceImpl, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createLargeDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getImportantIcon, getListInfoParam, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTimeRemainingFraction, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isHidden, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyPlayerAboutToOpenIntelScreen, reportMadeVisibleToPlayer, reportPlayerClickedOn, reportRemovedIntel, runWhilePaused, sendUpdate, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, setForceAddNextFrame, setHidden, setImportant, setListInfoParam, setNew, setPlayerVisibleTimestamp, setPostingLocation, setPostingRangeLY, setPostingRangeLY, shouldRemoveIntel, storyActionConfirmed, tableRowClicked, unindent

Methods inherited from class java.lang.Object

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

Field Detail

PREPARE_ACTION

public static java.lang.String PREPARE_ACTION

TRAVEL_ACTION

public static java.lang.String TRAVEL_ACTION

PAYLOAD_ACTION

public static java.lang.String PAYLOAD_ACTION

RETURN_ACTION

public static java.lang.String RETURN_ACTION

params

protected GenericRaidFGI.GenericRaidParams params

origin

protected SectorEntityToken origin

raidAction

protected GenericRaidFGI.GenericPayloadAction raidAction

travelAction

protected FGTravelAction travelAction

returnAction

protected FGTravelAction returnAction

waitAction

protected FGWaitAction waitAction

Constructor Detail

GenericRaidFGI

public GenericRaidFGI(GenericRaidFGI.GenericRaidParams params)

Method Detail

get

public static GenericRaidFGI get(java.lang.String key)

notifyEnding

protected void notifyEnding()

Overrides:

notifyEnding in class BaseIntelPlugin

initActions

protected void initActions()

createPayloadAction

protected GenericRaidFGI.GenericPayloadAction createPayloadAction()

spawnFleets

protected void spawnFleets()

Specified by:

spawnFleets in class FleetGroupIntel

createFleet

protected CampaignFleetAPI createFleet(int size,
                           float damage)

getFleetCreationFactionOverride

protected java.lang.String getFleetCreationFactionOverride(int size)

preConfigureFleet

protected void preConfigureFleet(int size,
                     FleetCreatorMission m)

configureFleet

protected void configureFleet(int size,
                  FleetCreatorMission m)

configureFleet

protected void configureFleet(int size,
                  CampaignFleetAPI fleet)

addTargetingBulletPoint

protected void addTargetingBulletPoint(TooltipMakerAPI info,
                           java.awt.Color tc,
                           java.lang.Object param,
                           IntelInfoPlugin.ListInfoMode mode,
                           float initPad)

addNonUpdateBulletPoints

protected void addNonUpdateBulletPoints(TooltipMakerAPI info,
                            java.awt.Color tc,
                            java.lang.Object param,
                            IntelInfoPlugin.ListInfoMode mode,
                            float initPad)

Specified by:

addNonUpdateBulletPoints in class FleetGroupIntel

addUpdateBulletPoints

protected void addUpdateBulletPoints(TooltipMakerAPI info,
                         java.awt.Color tc,
                         java.lang.Object param,
                         IntelInfoPlugin.ListInfoMode mode,
                         float initPad)

Specified by:

addUpdateBulletPoints in class FleetGroupIntel

shouldSendIntelUpdateWhenActionFinished

protected boolean shouldSendIntelUpdateWhenActionFinished(FGAction action)

Overrides:

shouldSendIntelUpdateWhenActionFinished in class FleetGroupIntel

addBasicDescription

protected void addBasicDescription(TooltipMakerAPI info,
                       float width,
                       float height,
                       float opad)

Overrides:

addBasicDescription in class FleetGroupIntel

addAssessmentSection

protected void addAssessmentSection(TooltipMakerAPI info,
                        float width,
                        float height,
                        float opad)

Overrides:

addAssessmentSection in class FleetGroupIntel

getAssessmentRiskStringOverride

protected java.lang.String getAssessmentRiskStringOverride()

getAssessmentRiskStringHighlightOverride

protected java.lang.String getAssessmentRiskStringHighlightOverride()

addPayloadActionStatus

protected void addPayloadActionStatus(TooltipMakerAPI info,
                          float width,
                          float height,
                          float opad)

addStatusSection

protected void addStatusSection(TooltipMakerAPI info,
                    float width,
                    float height,
                    float opad)

Overrides:

addStatusSection in class FleetGroupIntel

getNoun

public java.lang.String getNoun()

getForcesNoun

public java.lang.String getForcesNoun()

getBaseName

public java.lang.String getBaseName()

Specified by:

getBaseName in class FleetGroupIntel

isSucceeded

public boolean isSucceeded()

Overrides:

isSucceeded in class FleetGroupIntel

isFailed

public boolean isFailed()

Overrides:

isFailed in class FleetGroupIntel

getSource

protected SectorEntityToken getSource()

Specified by:

getSource in class FleetGroupIntel

getDestination

protected SectorEntityToken getDestination()

Specified by:

getDestination in class FleetGroupIntel

getTargetSystem

protected StarSystemAPI getTargetSystem()

getRaidAction

public GenericRaidFGI.GenericPayloadAction getRaidAction()

getTravelAction

public FGTravelAction getTravelAction()

getReturnAction

public FGTravelAction getReturnAction()

getWaitAction

public FGWaitAction getWaitAction()

getCommMessageSound

public java.lang.String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class FleetGroupIntel

isPlayerTargeted

public boolean isPlayerTargeted()

Specified by:

isPlayerTargeted in class FleetGroupIntel

getIntelTags

public java.util.Set<java.lang.String> getIntelTags(SectorMapAPI map)

Description copied from interface: IntelInfoPlugin

Method NEEDS to handle map being null gracefully.

Specified by:

getIntelTags in interface IntelInfoPlugin

Overrides:

getIntelTags in class FleetGroupIntel

Returns:

getArrowData

public java.util.List<IntelInfoPlugin.ArrowData> getArrowData(SectorMapAPI map)

Specified by:

getArrowData in interface IntelInfoPlugin

Overrides:

getArrowData in class FleetGroupIntel

getParams

public GenericRaidFGI.GenericRaidParams getParams()

setOrigin

public void setOrigin(SectorEntityToken origin)

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

Overrides:

getMapLocation in class FleetGroupIntel

hasCustomRaidAction

public boolean hasCustomRaidAction()

doCustomRaidAction

public void doCustomRaidAction(CampaignFleetAPI fleet,
                      MarketAPI market,
                      float raidStr)