Package com.fs.starfarer.api.campaign

Interface SubmarketPlugin

All Known Implementing Classes:

BaseSubmarketPlugin, BlackMarketPlugin, LocalResourcesSubmarketPlugin, MilitarySubmarketPlugin, OpenMarketPlugin, StoragePlugin

public interface SubmarketPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SubmarketPlugin.DialogOption
static enum	SubmarketPlugin.OnClickAction
static enum	SubmarketPlugin.PlayerEconomyImpactMode
static enum	SubmarketPlugin.TransferAction

Method Summary

Modifier and Type	Method	Description
void	addAllCargo(CargoAPI otherCargo)
void	advance(float amount)
void	createTooltip(CoreUIAPI ui, TooltipMakerAPI tooltip, boolean expanded)
String	getBuyVerb()
CargoAPI	getCargo()
CargoAPI	getCargoNullOk()
SubmarketPlugin.DialogOption[]	getDialogOptions(CoreUIAPI ui)
String	getDialogText(CoreUIAPI ui)
Highlights	getDialogTextHighlights(CoreUIAPI ui)
String	getIllegalTransferText(CargoStackAPI stack, SubmarketPlugin.TransferAction action)
String	getIllegalTransferText(FleetMemberAPI member, SubmarketPlugin.TransferAction action)
Highlights	getIllegalTransferTextHighlights(CargoStackAPI stack, SubmarketPlugin.TransferAction action)
Highlights	getIllegalTransferTextHighlights(FleetMemberAPI member, SubmarketPlugin.TransferAction action)
String	getName()
SubmarketPlugin.OnClickAction	getOnClickAction(CoreUIAPI ui)
SubmarketPlugin.PlayerEconomyImpactMode	getPlayerEconomyImpactMode()
float	getPlayerTradeImpactMult()
String	getSellVerb()
SubmarketAPI	getSubmarket()
float	getTariff()	Fraction of value that gets used as tariff.
String	getTariffTextOverride()
String	getTariffValueOverride()
String	getTooltipAppendix(CoreUIAPI ui)
Highlights	getTooltipAppendixHighlights(CoreUIAPI ui)
float	getTooltipWidth()
String	getTotalTextOverride()
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(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()
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
boolean	showInCargoScreen()
boolean	showInFleetScreen()
void	updateCargoPrePlayerInteraction()

Method Details

init

void init(SubmarketAPI submarket)

getName

String getName()

updateCargoPrePlayerInteraction

void updateCargoPrePlayerInteraction()

getCargo

CargoAPI getCargo()

addAllCargo

void addAllCargo(CargoAPI otherCargo)

isIllegalOnSubmarket

boolean isIllegalOnSubmarket(String commodityId,
 SubmarketPlugin.TransferAction action)

isIllegalOnSubmarket

boolean isIllegalOnSubmarket(CargoStackAPI stack,
 SubmarketPlugin.TransferAction action)

getIllegalTransferText

String getIllegalTransferText(CargoStackAPI stack,
 SubmarketPlugin.TransferAction action)

getIllegalTransferTextHighlights

Highlights getIllegalTransferTextHighlights(CargoStackAPI stack,
 SubmarketPlugin.TransferAction action)

isIllegalOnSubmarket

boolean isIllegalOnSubmarket(FleetMemberAPI member,
 SubmarketPlugin.TransferAction action)

getIllegalTransferText

String getIllegalTransferText(FleetMemberAPI member,
 SubmarketPlugin.TransferAction action)

getIllegalTransferTextHighlights

Highlights getIllegalTransferTextHighlights(FleetMemberAPI member,
 SubmarketPlugin.TransferAction action)

advance

void advance(float amount)

getTariff

float getTariff()

Fraction of value that gets used as tariff.

Returns:

isFreeTransfer

boolean isFreeTransfer()

getSellVerb

String getSellVerb()

getBuyVerb

String getBuyVerb()

reportPlayerMarketTransaction

void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

isBlackMarket

boolean isBlackMarket()

isOpenMarket

boolean isOpenMarket()

isMilitaryMarket

boolean isMilitaryMarket()

isParticipatesInEconomy

boolean isParticipatesInEconomy()

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

Returns:

isEnabled

boolean isEnabled(CoreUIAPI ui)

getOnClickAction

SubmarketPlugin.OnClickAction getOnClickAction(CoreUIAPI ui)

getDialogText

String getDialogText(CoreUIAPI ui)

getDialogTextHighlights

Highlights getDialogTextHighlights(CoreUIAPI ui)

getDialogOptions

SubmarketPlugin.DialogOption[] getDialogOptions(CoreUIAPI ui)

getTooltipAppendix

String getTooltipAppendix(CoreUIAPI ui)

getTooltipAppendixHighlights

Highlights getTooltipAppendixHighlights(CoreUIAPI ui)

getCargoNullOk

CargoAPI getCargoNullOk()

isTooltipExpandable

boolean isTooltipExpandable()

getTooltipWidth

float getTooltipWidth()

createTooltip

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

hasCustomTooltip

boolean hasCustomTooltip()

isHidden

boolean isHidden()

showInFleetScreen

boolean showInFleetScreen()

showInCargoScreen

boolean showInCargoScreen()

getPlayerTradeImpactMult

float getPlayerTradeImpactMult()

getPlayerEconomyImpactMode

SubmarketPlugin.PlayerEconomyImpactMode getPlayerEconomyImpactMode()

getTariffTextOverride

String getTariffTextOverride()

getTariffValueOverride

String getTariffValueOverride()

getTotalTextOverride

String getTotalTextOverride()

getTotalValueOverride

String getTotalValueOverride()

getSubmarket

SubmarketAPI getSubmarket()

okToUpdateShipsAndWeapons

boolean okToUpdateShipsAndWeapons()