com.fs.starfarer.api.impl.campaign.submarkets

Class BaseSubmarketPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.submarkets.BaseSubmarketPlugin

All Implemented Interfaces:

SubmarketPlugin

Direct Known Subclasses:

BlackMarketPlugin, LocalResourcesSubmarketPlugin, MilitarySubmarketPlugin, OpenMarketPlugin, StoragePlugin

public class BaseSubmarketPlugin
extends java.lang.Object
implements SubmarketPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseSubmarketPlugin.ShipSalesData

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

SubmarketPlugin.DialogOption, SubmarketPlugin.OnClickAction, SubmarketPlugin.PlayerEconomyImpactMode, SubmarketPlugin.TransferAction

Field Summary

Fields

Modifier and Type	Field and Description
protected CargoAPI	cargo
protected java.util.Random	itemGenRandom
protected MarketAPI	market
protected float	minSWUpdateInterval
protected float	sinceLastCargoUpdate
protected float	sinceSWUpdate
protected SubmarketAPI	submarket
static float	TRADE_IMPACT_DAYS

Constructor Summary

Constructors

Constructor and Description
BaseSubmarketPlugin()

Method Summary

Modifier and Type	Method and Description
void	addAllCargo(CargoAPI otherCargo)
void	addAndRemoveStockpiledResources(CommodityOnMarketAPI com, float amount, boolean withShortageCountering, boolean withDecreaseToLimit, boolean withCargoUpdate)
void	addAndRemoveStockpiledResources(float amount, boolean withShortageCountering, boolean withDecreaseToLimit, boolean withCargoUpdate)
protected void	addFighters(int min, int max, int maxTier, java.lang.String factionId)
protected void	addFighters(int min, int max, int maxTier, WeightedRandomPicker<java.lang.String> factionPicker)
protected void	addHullMods(int maxTier, int num)
protected void	addHullMods(int maxTier, int num, java.lang.String factionId)
protected FleetMemberAPI	addShip(java.lang.String variantOrWingId, boolean withDmods, float quality)
void	addShips(java.lang.String factionId, float combat, float freighter, float tanker, float transport, float liner, float utility, java.lang.Float qualityOverride, float qualityMod, FactionAPI.ShipPickMode modeOverride, FactionDoctrineAPI doctrineOverride)
void	addShips(java.lang.String factionId, float combat, float freighter, float tanker, float transport, float liner, float utility, java.lang.Float qualityOverride, float qualityMod, FactionAPI.ShipPickMode modeOverride, FactionDoctrineAPI doctrineOverride, int maxShipSize)
protected void	addWeapons(int min, int max, int maxTier, java.lang.String factionId)
protected void	addWeapons(int min, int max, int maxTier, java.lang.String factionId, boolean withCategories)
protected void	addWeapons(int min, int max, int maxTier, WeightedRandomPicker<java.lang.String> factionPicker)
protected void	addWeapons(int min, int max, int maxTier, WeightedRandomPicker<java.lang.String> factionPicker, boolean withCategories)
void	advance(float amount)
protected boolean	cargoAlreadyHasMod(java.lang.String id)
void	createTooltip(CoreUIAPI ui, TooltipMakerAPI tooltip, boolean expanded)
protected void	createTooltipAfterDescription(TooltipMakerAPI tooltip, boolean expanded)
protected boolean	doShortageCountering(CommodityOnMarketAPI com, float amount, boolean withShortageCountering)
java.lang.String	getBuyVerb()
CargoAPI	getCargo()
CargoAPI	getCargoNullOk()
SubmarketPlugin.DialogOption[]	getDialogOptions(CoreUIAPI ui)
java.lang.String	getDialogText(CoreUIAPI ui)
Highlights	getDialogTextHighlights(CoreUIAPI ui)
java.lang.String	getIllegalTransferText(CargoStackAPI stack, SubmarketPlugin.TransferAction action)
java.lang.String	getIllegalTransferText(FleetMemberAPI member, SubmarketPlugin.TransferAction action)
Highlights	getIllegalTransferTextHighlights(CargoStackAPI stack, SubmarketPlugin.TransferAction action)
Highlights	getIllegalTransferTextHighlights(FleetMemberAPI member, SubmarketPlugin.TransferAction action)
MarketAPI	getMarket()
float	getMinSWUpdateInterval()
java.lang.String	getName()
SubmarketPlugin.OnClickAction	getOnClickAction(CoreUIAPI ui)
SubmarketPlugin.PlayerEconomyImpactMode	getPlayerEconomyImpactMode()
float	getPlayerTradeImpactMult()
java.lang.String	getSellVerb()
float	getSinceLastCargoUpdate()
float	getSinceSWUpdate()
int	getStockpileLimit(CommodityOnMarketAPI com)
float	getStockpilingAddRateMult(CommodityOnMarketAPI com)
SubmarketAPI	getSubmarket()
float	getTariff() Fraction of value that gets used as tariff.
java.lang.String	getTariffTextOverride()
java.lang.String	getTariffValueOverride()
java.lang.String	getTooltipAppendix(CoreUIAPI ui)
Highlights	getTooltipAppendixHighlights(CoreUIAPI ui)
float	getTooltipWidth()
java.lang.String	getTotalTextOverride()
java.lang.String	getTotalValueOverride()
boolean	hasCustomTooltip()
void	init(SubmarketAPI submarket)
boolean	isBlackMarket()
boolean	isEnabled(CoreUIAPI ui)
boolean	isFreeTransfer()
boolean	isHidden()
boolean	isIllegalOnSubmarket(CargoStackAPI stack, SubmarketPlugin.TransferAction action)
boolean	isIllegalOnSubmarket(FleetMemberAPI member, SubmarketPlugin.TransferAction action)
boolean	isIllegalOnSubmarket(java.lang.String commodityId, SubmarketPlugin.TransferAction action)
boolean	isMilitaryMarket()
boolean	isOpenMarket()
boolean	isParticipatesInEconomy() Whether transactions with this submarket affect the market's supply/demand and result in reputation changes for the player.
boolean	isTooltipExpandable()
boolean	okToUpdateShipsAndWeapons()
protected void	pickAndAddWeapons(WeightedRandomPicker<WeaponSpecAPI> picker)
protected void	pruneShips(float mult)
protected void	pruneWeapons(float keepFraction)
protected java.lang.Object	readResolve()
protected boolean	removeModFromCargo(java.lang.String id)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	setCargo(CargoAPI cargo)
void	setMinSWUpdateInterval(float minCargoUpdateInterval)
void	setSinceLastCargoUpdate(float sinceLastCargoUpdate)
void	setSinceSWUpdate(float sinceSWUpdate)
boolean	shouldHaveCommodity(CommodityOnMarketAPI com)
boolean	showInCargoScreen()
boolean	showInFleetScreen()
void	updateCargoPrePlayerInteraction()

Methods inherited from class java.lang.Object

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

Field Detail

TRADE_IMPACT_DAYS

public static float TRADE_IMPACT_DAYS

market

protected MarketAPI market

submarket

protected SubmarketAPI submarket

cargo

protected CargoAPI cargo

minSWUpdateInterval

protected float minSWUpdateInterval

sinceSWUpdate

protected float sinceSWUpdate

sinceLastCargoUpdate

protected float sinceLastCargoUpdate

itemGenRandom

protected java.util.Random itemGenRandom

Constructor Detail

BaseSubmarketPlugin

public BaseSubmarketPlugin()

Method Detail

init

public void init(SubmarketAPI submarket)

Specified by:

init in interface SubmarketPlugin

readResolve

protected java.lang.Object readResolve()

getName

public java.lang.String getName()

Specified by:

getName in interface SubmarketPlugin

getCargo

public CargoAPI getCargo()

Specified by:

getCargo in interface SubmarketPlugin

getCargoNullOk

public CargoAPI getCargoNullOk()

Specified by:

getCargoNullOk in interface SubmarketPlugin

setCargo

public void setCargo(CargoAPI cargo)

updateCargoPrePlayerInteraction

public void updateCargoPrePlayerInteraction()

Specified by:

updateCargoPrePlayerInteraction in interface SubmarketPlugin

advance

public void advance(float amount)

Specified by:

advance in interface SubmarketPlugin

okToUpdateShipsAndWeapons

public boolean okToUpdateShipsAndWeapons()

Specified by:

okToUpdateShipsAndWeapons in interface SubmarketPlugin

addAllCargo

public void addAllCargo(CargoAPI otherCargo)

Specified by:

addAllCargo in interface SubmarketPlugin

getTariff

public float getTariff()

Description copied from interface: SubmarketPlugin

Fraction of value that gets used as tariff.

Specified by:

getTariff in interface SubmarketPlugin

Returns:

getBuyVerb

public java.lang.String getBuyVerb()

Specified by:

getBuyVerb in interface SubmarketPlugin

getSellVerb

public java.lang.String getSellVerb()

Specified by:

getSellVerb in interface SubmarketPlugin

isFreeTransfer

public boolean isFreeTransfer()

Specified by:

isFreeTransfer in interface SubmarketPlugin

isEnabled

public boolean isEnabled(CoreUIAPI ui)

Specified by:

isEnabled in interface SubmarketPlugin

getOnClickAction

public SubmarketPlugin.OnClickAction getOnClickAction(CoreUIAPI ui)

Specified by:

getOnClickAction in interface SubmarketPlugin

getDialogText

public java.lang.String getDialogText(CoreUIAPI ui)

Specified by:

getDialogText in interface SubmarketPlugin

getDialogTextHighlights

public Highlights getDialogTextHighlights(CoreUIAPI ui)

Specified by:

getDialogTextHighlights in interface SubmarketPlugin

getDialogOptions

public SubmarketPlugin.DialogOption[] getDialogOptions(CoreUIAPI ui)

Specified by:

getDialogOptions in interface SubmarketPlugin

getTooltipAppendix

public java.lang.String getTooltipAppendix(CoreUIAPI ui)

Specified by:

getTooltipAppendix in interface SubmarketPlugin

getTooltipAppendixHighlights

public Highlights getTooltipAppendixHighlights(CoreUIAPI ui)

Specified by:

getTooltipAppendixHighlights in interface SubmarketPlugin

getPlayerEconomyImpactMode

public SubmarketPlugin.PlayerEconomyImpactMode getPlayerEconomyImpactMode()

Specified by:

getPlayerEconomyImpactMode in interface SubmarketPlugin

getPlayerTradeImpactMult

public float getPlayerTradeImpactMult()

Specified by:

getPlayerTradeImpactMult in interface SubmarketPlugin

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction in interface SubmarketPlugin

isMilitaryMarket

public boolean isMilitaryMarket()

Specified by:

isMilitaryMarket in interface SubmarketPlugin

isBlackMarket

public boolean isBlackMarket()

Specified by:

isBlackMarket in interface SubmarketPlugin

isOpenMarket

public boolean isOpenMarket()

Specified by:

isOpenMarket in interface SubmarketPlugin

isParticipatesInEconomy

public boolean isParticipatesInEconomy()

Description copied from interface: SubmarketPlugin

Whether transactions with this submarket affect the market's supply/demand and result in reputation changes for the player.

Specified by:

isParticipatesInEconomy in interface SubmarketPlugin

Returns:

isIllegalOnSubmarket

public boolean isIllegalOnSubmarket(java.lang.String commodityId,
                                    SubmarketPlugin.TransferAction action)

Specified by:

isIllegalOnSubmarket in interface SubmarketPlugin

isIllegalOnSubmarket

public boolean isIllegalOnSubmarket(CargoStackAPI stack,
                                    SubmarketPlugin.TransferAction action)

Specified by:

isIllegalOnSubmarket in interface SubmarketPlugin

getIllegalTransferText

public java.lang.String getIllegalTransferText(CargoStackAPI stack,
                                               SubmarketPlugin.TransferAction action)

Specified by:

getIllegalTransferText in interface SubmarketPlugin

isIllegalOnSubmarket

public boolean isIllegalOnSubmarket(FleetMemberAPI member,
                                    SubmarketPlugin.TransferAction action)

Specified by:

isIllegalOnSubmarket in interface SubmarketPlugin

getIllegalTransferText

public java.lang.String getIllegalTransferText(FleetMemberAPI member,
                                               SubmarketPlugin.TransferAction action)

Specified by:

getIllegalTransferText in interface SubmarketPlugin

addFighters

protected void addFighters(int min,
                           int max,
                           int maxTier,
                           WeightedRandomPicker<java.lang.String> factionPicker)

addWeapons

protected void addWeapons(int min,
                          int max,
                          int maxTier,
                          java.lang.String factionId)

addWeapons

protected void addWeapons(int min,
                          int max,
                          int maxTier,
                          java.lang.String factionId,
                          boolean withCategories)

addWeapons

protected void addWeapons(int min,
                          int max,
                          int maxTier,
                          WeightedRandomPicker<java.lang.String> factionPicker)

addWeapons

protected void addWeapons(int min,
                          int max,
                          int maxTier,
                          WeightedRandomPicker<java.lang.String> factionPicker,
                          boolean withCategories)

pickAndAddWeapons

protected void pickAndAddWeapons(WeightedRandomPicker<WeaponSpecAPI> picker)

addFighters

protected void addFighters(int min,
                           int max,
                           int maxTier,
                           java.lang.String factionId)

pruneWeapons

protected void pruneWeapons(float keepFraction)

addShips

public void addShips(java.lang.String factionId,
                     float combat,
                     float freighter,
                     float tanker,
                     float transport,
                     float liner,
                     float utility,
                     java.lang.Float qualityOverride,
                     float qualityMod,
                     FactionAPI.ShipPickMode modeOverride,
                     FactionDoctrineAPI doctrineOverride)

addShips

public void addShips(java.lang.String factionId,
                     float combat,
                     float freighter,
                     float tanker,
                     float transport,
                     float liner,
                     float utility,
                     java.lang.Float qualityOverride,
                     float qualityMod,
                     FactionAPI.ShipPickMode modeOverride,
                     FactionDoctrineAPI doctrineOverride,
                     int maxShipSize)

addShip

protected FleetMemberAPI addShip(java.lang.String variantOrWingId,
                                 boolean withDmods,
                                 float quality)

pruneShips

protected void pruneShips(float mult)

addHullMods

protected void addHullMods(int maxTier,
                           int num)

addHullMods

protected void addHullMods(int maxTier,
                           int num,
                           java.lang.String factionId)

removeModFromCargo

protected boolean removeModFromCargo(java.lang.String id)

cargoAlreadyHasMod

protected boolean cargoAlreadyHasMod(java.lang.String id)

getIllegalTransferTextHighlights

public Highlights getIllegalTransferTextHighlights(CargoStackAPI stack,
                                                   SubmarketPlugin.TransferAction action)

Specified by:

getIllegalTransferTextHighlights in interface SubmarketPlugin

getIllegalTransferTextHighlights

public Highlights getIllegalTransferTextHighlights(FleetMemberAPI member,
                                                   SubmarketPlugin.TransferAction action)

Specified by:

getIllegalTransferTextHighlights in interface SubmarketPlugin

getMinSWUpdateInterval

public float getMinSWUpdateInterval()

setMinSWUpdateInterval

public void setMinSWUpdateInterval(float minCargoUpdateInterval)

getSinceLastCargoUpdate

public float getSinceLastCargoUpdate()

setSinceLastCargoUpdate

public void setSinceLastCargoUpdate(float sinceLastCargoUpdate)

getSinceSWUpdate

public float getSinceSWUpdate()

setSinceSWUpdate

public void setSinceSWUpdate(float sinceSWUpdate)

hasCustomTooltip

public boolean hasCustomTooltip()

Specified by:

hasCustomTooltip in interface SubmarketPlugin

createTooltip

public void createTooltip(CoreUIAPI ui,
                          TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface SubmarketPlugin

createTooltipAfterDescription

protected void createTooltipAfterDescription(TooltipMakerAPI tooltip,
                                             boolean expanded)

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface SubmarketPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface SubmarketPlugin

isHidden

public boolean isHidden()

Specified by:

isHidden in interface SubmarketPlugin

showInFleetScreen

public boolean showInFleetScreen()

Specified by:

showInFleetScreen in interface SubmarketPlugin

showInCargoScreen

public boolean showInCargoScreen()

Specified by:

showInCargoScreen in interface SubmarketPlugin

getMarket

public MarketAPI getMarket()

getSubmarket

public SubmarketAPI getSubmarket()

Specified by:

getSubmarket in interface SubmarketPlugin

getStockpileLimit

public int getStockpileLimit(CommodityOnMarketAPI com)

getStockpilingAddRateMult

public float getStockpilingAddRateMult(CommodityOnMarketAPI com)

shouldHaveCommodity

public boolean shouldHaveCommodity(CommodityOnMarketAPI com)

addAndRemoveStockpiledResources

public void addAndRemoveStockpiledResources(float amount,
                                            boolean withShortageCountering,
                                            boolean withDecreaseToLimit,
                                            boolean withCargoUpdate)

doShortageCountering

protected boolean doShortageCountering(CommodityOnMarketAPI com,
                                       float amount,
                                       boolean withShortageCountering)

addAndRemoveStockpiledResources

public void addAndRemoveStockpiledResources(CommodityOnMarketAPI com,
                                            float amount,
                                            boolean withShortageCountering,
                                            boolean withDecreaseToLimit,
                                            boolean withCargoUpdate)

getTariffTextOverride

public java.lang.String getTariffTextOverride()

Specified by:

getTariffTextOverride in interface SubmarketPlugin

getTariffValueOverride

public java.lang.String getTariffValueOverride()

Specified by:

getTariffValueOverride in interface SubmarketPlugin

getTotalTextOverride

public java.lang.String getTotalTextOverride()

Specified by:

getTotalTextOverride in interface SubmarketPlugin

getTotalValueOverride

public java.lang.String getTotalValueOverride()

Specified by:

getTotalValueOverride in interface SubmarketPlugin