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

Class RaidIntel

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.intel.raid.RaidIntel

All Implemented Interfaces:

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

Direct Known Subclasses:

HegemonyInspectionIntel, PunitiveExpeditionIntel

public class RaidIntel
extends BaseIntelPlugin
implements RouteManager.RouteFleetSpawner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RaidIntel.RaidDelegate
static interface	RaidIntel.RaidStage
static class	RaidIntel.RaidStageStatus

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 int	currentStage
protected float	defenderStr
protected RaidIntel.RaidDelegate	delegate
static java.lang.Object	ENTERED_SYSTEM_UPDATE
protected float	extraDays
protected FactionAPI	faction
protected int	failStage
protected java.lang.String	id
protected java.lang.String	sid
protected java.util.List<RaidIntel.RaidStage>	stages
protected StarSystemAPI	system
static java.lang.Object	UPDATE_FAILED
static java.lang.Object	UPDATE_RETURNING

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, tagsForSort, timestamp

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

LIST_ITEM_TEXT_WIDTH, NEW_DAYS

Constructor Summary

Constructors

Constructor and Description
RaidIntel(StarSystemAPI system, FactionAPI faction, RaidIntel.RaidDelegate delegate)

Method Summary

Modifier and Type	Method and Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	addStage(RaidIntel.RaidStage stage)
void	addStandardStrengthComparisons(TooltipMakerAPI info, MarketAPI target, FactionAPI targetFaction, boolean withGround, boolean withBombard, java.lang.String raid, java.lang.String raids)
protected void	advanceImpl(float amount)
boolean	canMakeVisibleToPlayer(boolean playerInRelayRange) Only checked if adding using IntelManager.queueIntel().
RouteFleetAssignmentAI	createAssignmentAI(CampaignFleetAPI fleet, RouteManager.RouteData route)
CampaignFleetAPI	createFleet(java.lang.String factionId, RouteManager.RouteData route, MarketAPI market, org.lwjgl.util.vector.Vector2f locInHyper, java.util.Random random)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
protected void	failedAtStage(RaidIntel.RaidStage stage)
void	forceFail(boolean withUpdate)
ActionStage	getActionStage()
java.util.List<IntelInfoPlugin.ArrowData>	getArrowData(SectorMapAPI map)
AssembleStage	getAssembleStage()
java.lang.String	getCommMessageSound()
int	getCurrentStage()
float	getETA()
float	getExtraDays()
FactionAPI	getFaction()
FactionAPI	getFactionForUIColors()
int	getFailStage()
protected MarketAPI	getFirstSource()
java.lang.String	getIcon() 40x40, no icon if null.
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
SectorEntityToken	getMapLocation(SectorMapAPI map)
java.lang.String	getName()
float	getNumFleets()
OrganizeStage	getOrganizeStage()
float	getOrigNumFleets()
float	getRaidFP()
float	getRaidFPAdjusted()
float	getRaidStr()
protected java.lang.String	getRaidStrDesc()
java.lang.String	getRouteSourceId()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
IntelInfoPlugin.IntelSortTier	getSortTier()
int	getStageIndex(RaidIntel.RaidStage stage)
StarSystemAPI	getSystem()
boolean	isFailed()
boolean	isPlayerTargeted()
boolean	isSucceeded()
protected void	notifyEnded()
protected void	notifyEnding()
void	reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)
void	sendEnteredSystemUpdate()
void	setExtraDays(float extraDays)
boolean	shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)
boolean	shouldRepeat(RouteManager.RouteData route)
boolean	shouldSendUpdate()
CampaignFleetAPI	spawnFleet(RouteManager.RouteData route)

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

addBulletPoints, addDays, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addLogTimestamp, addMarketTable, addMarketToList, addMarketToList, advance, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, 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, getSortStringNewestFirst, getSortStringNewestFirst, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, 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, setTagsForSort, shouldRemoveIntel, storyActionConfirmed, tableRowClicked, unindent

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_FAILED

public static java.lang.Object UPDATE_FAILED

UPDATE_RETURNING

public static java.lang.Object UPDATE_RETURNING

ENTERED_SYSTEM_UPDATE

public static java.lang.Object ENTERED_SYSTEM_UPDATE

currentStage

protected int currentStage

failStage

protected int failStage

stages

protected java.util.List<RaidIntel.RaidStage> stages

id

protected java.lang.String id

sid

protected java.lang.String sid

extraDays

protected float extraDays

system

protected StarSystemAPI system

faction

protected FactionAPI faction

defenderStr

protected float defenderStr

delegate

protected RaidIntel.RaidDelegate delegate

Constructor Detail

RaidIntel

public RaidIntel(StarSystemAPI system,
                 FactionAPI faction,
                 RaidIntel.RaidDelegate delegate)

Method Detail

sendEnteredSystemUpdate

public void sendEnteredSystemUpdate()

getSystem

public StarSystemAPI getSystem()

getCurrentStage

public int getCurrentStage()

getStageIndex

public int getStageIndex(RaidIntel.RaidStage stage)

getFailStage

public int getFailStage()

getOrganizeStage

public OrganizeStage getOrganizeStage()

getAssembleStage

public AssembleStage getAssembleStage()

getActionStage

public ActionStage getActionStage()

addStage

public void addStage(RaidIntel.RaidStage stage)

getRouteSourceId

public java.lang.String getRouteSourceId()

getExtraDays

public float getExtraDays()

setExtraDays

public void setExtraDays(float extraDays)

canMakeVisibleToPlayer

public boolean canMakeVisibleToPlayer(boolean playerInRelayRange)

Description copied from interface: IntelInfoPlugin

Only checked if adding using IntelManager.queueIntel(). addIntel() bypasses this and all other checks.

Specified by:

canMakeVisibleToPlayer in interface IntelInfoPlugin

Overrides:

canMakeVisibleToPlayer in class BaseIntelPlugin

Returns:

shouldSendUpdate

public boolean shouldSendUpdate()

isPlayerTargeted

public boolean isPlayerTargeted()

getCommMessageSound

public java.lang.String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin

advanceImpl

protected void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

forceFail

public void forceFail(boolean withUpdate)

failedAtStage

protected void failedAtStage(RaidIntel.RaidStage stage)

notifyEnded

protected void notifyEnded()

Overrides:

notifyEnded in class BaseIntelPlugin

notifyEnding

protected void notifyEnding()

Overrides:

notifyEnding in class BaseIntelPlugin

getETA

public float getETA()

addBulletPoints

protected void addBulletPoints(TooltipMakerAPI info,
                               IntelInfoPlugin.ListInfoMode mode)

Overrides:

addBulletPoints in class BaseIntelPlugin

createIntelInfo

public void createIntelInfo(TooltipMakerAPI info,
                            IntelInfoPlugin.ListInfoMode mode)

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

getFirstSource

protected MarketAPI getFirstSource()

createSmallDescription

public void createSmallDescription(TooltipMakerAPI info,
                                   float width,
                                   float height)

Specified by:

createSmallDescription in interface IntelInfoPlugin

Overrides:

createSmallDescription in class BaseIntelPlugin

getIcon

public java.lang.String getIcon()

Description copied from interface: IntelInfoPlugin

40x40, no icon if null.

Specified by:

getIcon in interface IntelInfoPlugin

Overrides:

getIcon in class BaseIntelPlugin

Returns:

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 BaseIntelPlugin

Returns:

getSortString

public java.lang.String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class BaseIntelPlugin

getName

public java.lang.String getName()

Overrides:

getName in class BaseIntelPlugin

isFailed

public boolean isFailed()

isSucceeded

public boolean isSucceeded()

getFactionForUIColors

public FactionAPI getFactionForUIColors()

Specified by:

getFactionForUIColors in interface IntelInfoPlugin

Overrides:

getFactionForUIColors in class BaseIntelPlugin

getFaction

public FactionAPI getFaction()

getSmallDescriptionTitle

public java.lang.String getSmallDescriptionTitle()

Specified by:

getSmallDescriptionTitle in interface IntelInfoPlugin

Overrides:

getSmallDescriptionTitle in class BaseIntelPlugin

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

Overrides:

getMapLocation in class BaseIntelPlugin

getArrowData

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

Specified by:

getArrowData in interface IntelInfoPlugin

Overrides:

getArrowData in class BaseIntelPlugin

shouldCancelRouteAfterDelayCheck

public boolean shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)

Specified by:

shouldCancelRouteAfterDelayCheck in interface RouteManager.RouteFleetSpawner

shouldRepeat

public boolean shouldRepeat(RouteManager.RouteData route)

Specified by:

shouldRepeat in interface RouteManager.RouteFleetSpawner

reportAboutToBeDespawnedByRouteManager

public void reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)

Specified by:

reportAboutToBeDespawnedByRouteManager in interface RouteManager.RouteFleetSpawner

spawnFleet

public CampaignFleetAPI spawnFleet(RouteManager.RouteData route)

Specified by:

spawnFleet in interface RouteManager.RouteFleetSpawner

createAssignmentAI

public RouteFleetAssignmentAI createAssignmentAI(CampaignFleetAPI fleet,
                                                 RouteManager.RouteData route)

createFleet

public CampaignFleetAPI createFleet(java.lang.String factionId,
                                    RouteManager.RouteData route,
                                    MarketAPI market,
                                    org.lwjgl.util.vector.Vector2f locInHyper,
                                    java.util.Random random)

getRaidFPAdjusted

public float getRaidFPAdjusted()

getRaidFP

public float getRaidFP()

getNumFleets

public float getNumFleets()

getOrigNumFleets

public float getOrigNumFleets()

getRaidStr

public float getRaidStr()

getRaidStrDesc

protected java.lang.String getRaidStrDesc()

addStandardStrengthComparisons

public void addStandardStrengthComparisons(TooltipMakerAPI info,
                                           MarketAPI target,
                                           FactionAPI targetFaction,
                                           boolean withGround,
                                           boolean withBombard,
                                           java.lang.String raid,
                                           java.lang.String raids)

getSortTier

public IntelInfoPlugin.IntelSortTier getSortTier()

Specified by:

getSortTier in interface IntelInfoPlugin

Overrides:

getSortTier in class BaseIntelPlugin