com.fs.starfarer.api.impl.campaign.rulecmd.salvage.special

Class BaseSalvageSpecial

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.salvage.special.BaseSalvageSpecial

All Implemented Interfaces:

SalvageSpecialInteraction.SalvageSpecialPlugin

Direct Known Subclasses:

BlueprintSpecial, BreadcrumbSpecial, CargoManifestSpecial, DomainSurveyDerelictSpecial, ShipRecoverySpecial, SleeperPodsSpecial, SurveyDataSpecial, TopographicDataSpecial, TransmitterTrapSpecial

public class BaseSalvageSpecial
extends java.lang.Object
implements SalvageSpecialInteraction.SalvageSpecialPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseSalvageSpecial.ExtraSalvage

Field Summary

Fields

Modifier and Type	Field and Description
protected InteractionDialogAPI	dialog
protected boolean	done
protected boolean	endWithContinue
protected SectorEntityToken	entity
static java.lang.String	EXTRA_SALVAGE
protected java.util.Map<java.lang.String,MemoryAPI>	memoryMap
protected OptionPanelAPI	options
protected CampaignFleetAPI	playerFleet
protected java.util.Random	random
static java.lang.String	TEMP_EXTRA_SALVAGE
protected TextPanelAPI	text
protected VisualPanelAPI	visual

Constructor Summary

Constructors

Constructor and Description
BaseSalvageSpecial()

Method Summary

Modifier and Type	Method and Description
static void	addExtraSalvage(CargoAPI cargo, MemoryAPI memory, float expire)
static void	addExtraSalvage(SectorEntityToken entity, CargoAPI cargo)
protected void	addTempExtraSalvage(CargoAPI cargo)
void	addText(java.lang.String format)
static void	clearExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)
static void	clearExtraSalvage(MemoryAPI memory)
static void	clearExtraSalvage(SectorEntityToken entity)
boolean	endWithContinue()
static CargoAPI	getCombinedExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)
static CargoAPI	getCombinedExtraSalvage(SectorEntityToken entity)
static BaseSalvageSpecial.ExtraSalvage	getExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)
static BaseSalvageSpecial.ExtraSalvage	getExtraSalvage(MemoryAPI memory)
static BaseSalvageSpecial.ExtraSalvage	getExtraSalvage(SectorEntityToken entity)
java.lang.String	getString(java.lang.String format)
static BaseSalvageSpecial.ExtraSalvage	getTempExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)
static BaseSalvageSpecial.ExtraSalvage	getTempExtraSalvage(MemoryAPI memory)
static BaseSalvageSpecial.ExtraSalvage	getTempExtraSalvage(SectorEntityToken entity)
void	init(InteractionDialogAPI dialog, java.lang.Object specialData)
void	initNothing()
boolean	isDone()
void	optionSelected(java.lang.String optionText, java.lang.Object optionData)
void	setDone(boolean done)
void	setEndWithContinue(boolean endWithContinue)
void	setShouldAbortSalvageAndRemoveEntity(boolean shouldAbortSalvageAndRemoveEntity)
void	setShowAgain(boolean showAgain)
boolean	shouldAbortSalvageAndRemoveEntity()
boolean	shouldShowAgain()

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_SALVAGE

public static final java.lang.String EXTRA_SALVAGE

See Also:

Constant Field Values

TEMP_EXTRA_SALVAGE

public static final java.lang.String TEMP_EXTRA_SALVAGE

See Also:

Constant Field Values

done

protected boolean done

endWithContinue

protected boolean endWithContinue

dialog

protected InteractionDialogAPI dialog

random

protected java.util.Random random

entity

protected SectorEntityToken entity

text

protected TextPanelAPI text

options

protected OptionPanelAPI options

visual

protected VisualPanelAPI visual

memoryMap

protected java.util.Map<java.lang.String,MemoryAPI> memoryMap

playerFleet

protected CampaignFleetAPI playerFleet

Constructor Detail

BaseSalvageSpecial

public BaseSalvageSpecial()

Method Detail

addTempExtraSalvage

protected void addTempExtraSalvage(CargoAPI cargo)

addExtraSalvage

public static void addExtraSalvage(SectorEntityToken entity,
                                   CargoAPI cargo)

addExtraSalvage

public static void addExtraSalvage(CargoAPI cargo,
                                   MemoryAPI memory,
                                   float expire)

getCombinedExtraSalvage

public static CargoAPI getCombinedExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)

getCombinedExtraSalvage

public static CargoAPI getCombinedExtraSalvage(SectorEntityToken entity)

getTempExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getTempExtraSalvage(SectorEntityToken entity)

getExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getExtraSalvage(SectorEntityToken entity)

getExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getExtraSalvage(MemoryAPI memory)

getTempExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getTempExtraSalvage(MemoryAPI memory)

getTempExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getTempExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)

getExtraSalvage

public static BaseSalvageSpecial.ExtraSalvage getExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)

clearExtraSalvage

public static void clearExtraSalvage(java.util.Map<java.lang.String,MemoryAPI> memoryMap)

clearExtraSalvage

public static void clearExtraSalvage(MemoryAPI memory)

clearExtraSalvage

public static void clearExtraSalvage(SectorEntityToken entity)

init

public void init(InteractionDialogAPI dialog,
                 java.lang.Object specialData)

Specified by:

init in interface SalvageSpecialInteraction.SalvageSpecialPlugin

optionSelected

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

Specified by:

optionSelected in interface SalvageSpecialInteraction.SalvageSpecialPlugin

initNothing

public void initNothing()

isDone

public boolean isDone()

Specified by:

isDone in interface SalvageSpecialInteraction.SalvageSpecialPlugin

setDone

public void setDone(boolean done)

endWithContinue

public boolean endWithContinue()

Specified by:

endWithContinue in interface SalvageSpecialInteraction.SalvageSpecialPlugin

setEndWithContinue

public void setEndWithContinue(boolean endWithContinue)

getString

public java.lang.String getString(java.lang.String format)

addText

public void addText(java.lang.String format)

shouldShowAgain

public boolean shouldShowAgain()

Specified by:

shouldShowAgain in interface SalvageSpecialInteraction.SalvageSpecialPlugin

setShowAgain

public void setShowAgain(boolean showAgain)

shouldAbortSalvageAndRemoveEntity

public boolean shouldAbortSalvageAndRemoveEntity()

Specified by:

shouldAbortSalvageAndRemoveEntity in interface SalvageSpecialInteraction.SalvageSpecialPlugin

setShouldAbortSalvageAndRemoveEntity

public void setShouldAbortSalvageAndRemoveEntity(boolean shouldAbortSalvageAndRemoveEntity)