com.fs.starfarer.api.impl.campaign.intel.bar.events.historian

Class BaseHistorianOffer

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.intel.bar.events.historian.BaseHistorianOffer

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, HistorianData.HistorianOffer, CallEvent.CallableEvent

Direct Known Subclasses:

BaseHistorianOfferWithLocation, DonationOffer

public class BaseHistorianOffer
extends BaseIntelPlugin
implements HistorianData.HistorianOffer

Nested Class Summary

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 HistorianData.HistorianOfferCreator	creator
protected InteractionDialogAPI	dialog
protected boolean	done
protected boolean	endConversationOnReturning
protected OptionPanelAPI	options
protected boolean	remove
protected TextPanelAPI	text

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
BaseHistorianOffer()

Method Summary

Modifier and Type	Method and Description
void	addPromptAndOption(InteractionDialogAPI dialog)
HistorianData.HistorianOfferCreator	getCreator()
java.lang.String	getIcon() 40x40, no icon if null.
int	getSortOrder()
void	init(InteractionDialogAPI dialog)
boolean	isInteractionFinished()
void	notifyAccepted()
void	optionSelected(java.lang.String optionText, java.lang.Object optionData)
void	setCreator(HistorianData.HistorianOfferCreator creator)
void	setDone(boolean done)
void	setEndConversationOnReturning(boolean endConversationOnReturning)
void	setRemove(boolean remove)
boolean	shouldEndConversationOnReturning()
boolean	shouldRemoveOffer()

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

addBulletPoints, addBulletPoints, addDays, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addLogTimestamp, addMarketTable, addMarketToList, addMarketToList, advance, advanceImpl, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createIntelInfo, createLargeDescription, createSmallDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommMessageSound, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getFactionForUIColors, getImportantIcon, getIntelTags, getListInfoParam, getMapLocation, getName, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSmallDescriptionTitle, getSortString, getSortStringNewestFirst, getSortStringNewestFirst, getSortTier, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTimeRemainingFraction, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isHidden, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyEnded, notifyEnding, 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

done

protected transient boolean done

remove

protected transient boolean remove

endConversationOnReturning

protected transient boolean endConversationOnReturning

dialog

protected transient InteractionDialogAPI dialog

text

protected transient TextPanelAPI text

options

protected transient OptionPanelAPI options

creator

protected transient HistorianData.HistorianOfferCreator creator

Constructor Detail

BaseHistorianOffer

public BaseHistorianOffer()

Method Detail

init

public void init(InteractionDialogAPI dialog)

Specified by:

init in interface HistorianData.HistorianOffer

getCreator

public HistorianData.HistorianOfferCreator getCreator()

Specified by:

getCreator in interface HistorianData.HistorianOffer

setCreator

public void setCreator(HistorianData.HistorianOfferCreator creator)

Specified by:

setCreator in interface HistorianData.HistorianOffer

addPromptAndOption

public void addPromptAndOption(InteractionDialogAPI dialog)

Specified by:

addPromptAndOption in interface HistorianData.HistorianOffer

isInteractionFinished

public boolean isInteractionFinished()

Specified by:

isInteractionFinished in interface HistorianData.HistorianOffer

optionSelected

public void optionSelected(java.lang.String optionText,
                           java.lang.Object optionData)

Specified by:

optionSelected in interface HistorianData.HistorianOffer

setDone

public void setDone(boolean done)

shouldRemoveOffer

public boolean shouldRemoveOffer()

Specified by:

shouldRemoveOffer in interface HistorianData.HistorianOffer

setRemove

public void setRemove(boolean remove)

getSortOrder

public int getSortOrder()

Specified by:

getSortOrder in interface HistorianData.HistorianOffer

shouldEndConversationOnReturning

public boolean shouldEndConversationOnReturning()

Specified by:

shouldEndConversationOnReturning in interface HistorianData.HistorianOffer

setEndConversationOnReturning

public void setEndConversationOnReturning(boolean endConversationOnReturning)

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:

notifyAccepted

public void notifyAccepted()

Specified by:

notifyAccepted in interface HistorianData.HistorianOffer