com.fs.starfarer.api.impl.campaign.econ

Class BaseMarketConditionPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.econ.BaseMarketConditionPlugin

All Implemented Interfaces:

MarketConditionPlugin

Direct Known Subclasses:

AbandonedStation, BaseHazardCondition, BaseMarketConditionPlugin2, Blockaded, ClosedImmigration, CommRelayCondition, CottageIndustry, Dissident, EstablishedPolity, FoodShortage, FreeMarket, Frontier, Headquarters, HostileActivity, Hydroponics, IndustrialPolity, LargeRefugeePopulation, LuddicMajority, LuddicPathCells, OrbitalBurns, OrganizedCrime, Outpost, PiracyRespite, PirateActivity, Placeholder, Population, RecentUnrest, RegionalCapital, RogueAICore, RuralPolity, ShipbreakingCenter, ShippingDisruption, Smuggling, SolarArray, StealthMinefields, SystemBounty, TradeCenter, TradeDisruption, UrbanizedPolity, ViceDemand, WorldFarming, WorldUninhabitable

public class BaseMarketConditionPlugin
extends java.lang.Object
implements MarketConditionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected MarketConditionAPI	condition
protected MarketAPI	market

Constructor Summary

Constructors

Constructor and Description
BaseMarketConditionPlugin()

Method Summary

Modifier and Type	Method and Description
void	addTokensToList(java.util.List<java.lang.String> list, java.lang.String... keys)
void	advance(float amount)
void	apply(java.lang.String id)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
protected void	createTooltipAfterDescription(TooltipMakerAPI tooltip, boolean expanded)
java.awt.Color[]	getHighlightColors()
java.lang.String[]	getHighlights() For the description, which is shown in the tooltip.
static float	getHighStabilityBonusMult(MarketAPI market)
static float	getHighStabilityPenaltyMult(MarketAPI market)
java.lang.String	getIconName()
static float	getLowStabilityBonusMult(MarketAPI market)
static float	getLowStabilityPenaltyMult(MarketAPI market)
java.lang.String	getModId()
java.lang.String	getName()
java.util.List<java.lang.String>	getRelatedCommodities() Only used for conditions that come from events.
java.util.Map<java.lang.String,java.lang.String>	getTokenReplacements() For the description that shows up in the tooltip.
float	getTooltipWidth()
boolean	hasCustomTooltip()
void	init(MarketAPI market, MarketConditionAPI condition)
boolean	isPlanetary()
boolean	isTooltipExpandable()
boolean	isTransient() Return false if the plugin has data that needs to be in the savefile.
static void	main(java.lang.String[] args)
boolean	runWhilePaused()
void	setParam(java.lang.Object param)
boolean	showIcon()
void	unapply(java.lang.String id)

Methods inherited from class java.lang.Object

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

Field Detail

market

protected MarketAPI market

condition

protected MarketConditionAPI condition

Constructor Detail

BaseMarketConditionPlugin

public BaseMarketConditionPlugin()

Method Detail

init

public void init(MarketAPI market,
                 MarketConditionAPI condition)

Specified by:

init in interface MarketConditionPlugin

apply

public void apply(java.lang.String id)

Specified by:

apply in interface MarketConditionPlugin

unapply

public void unapply(java.lang.String id)

Specified by:

unapply in interface MarketConditionPlugin

advance

public void advance(float amount)

Specified by:

advance in interface MarketConditionPlugin

getModId

public java.lang.String getModId()

getLowStabilityBonusMult

public static float getLowStabilityBonusMult(MarketAPI market)

getLowStabilityPenaltyMult

public static float getLowStabilityPenaltyMult(MarketAPI market)

getHighStabilityBonusMult

public static float getHighStabilityBonusMult(MarketAPI market)

getHighStabilityPenaltyMult

public static float getHighStabilityPenaltyMult(MarketAPI market)

main

public static void main(java.lang.String[] args)

getRelatedCommodities

public java.util.List<java.lang.String> getRelatedCommodities()

Description copied from interface: MarketConditionPlugin

Only used for conditions that come from events.

Specified by:

getRelatedCommodities in interface MarketConditionPlugin

Returns:

setParam

public void setParam(java.lang.Object param)

Specified by:

setParam in interface MarketConditionPlugin

getTokenReplacements

public java.util.Map<java.lang.String,java.lang.String> getTokenReplacements()

Description copied from interface: MarketConditionPlugin

For the description that shows up in the tooltip.

Specified by:

getTokenReplacements in interface MarketConditionPlugin

Returns:

getHighlights

public java.lang.String[] getHighlights()

Description copied from interface: MarketConditionPlugin

For the description, which is shown in the tooltip.

Specified by:

getHighlights in interface MarketConditionPlugin

Returns:

getHighlightColors

public java.awt.Color[] getHighlightColors()

Specified by:

getHighlightColors in interface MarketConditionPlugin

addTokensToList

public void addTokensToList(java.util.List<java.lang.String> list,
                            java.lang.String... keys)

isTransient

public boolean isTransient()

Description copied from interface: MarketConditionPlugin

Return false if the plugin has data that needs to be in the savefile. Otherwise, it won't be saved.

Specified by:

isTransient in interface MarketConditionPlugin

Returns:

showIcon

public boolean showIcon()

Specified by:

showIcon in interface MarketConditionPlugin

hasCustomTooltip

public boolean hasCustomTooltip()

Specified by:

hasCustomTooltip in interface MarketConditionPlugin

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface MarketConditionPlugin

createTooltipAfterDescription

protected void createTooltipAfterDescription(TooltipMakerAPI tooltip,
                                             boolean expanded)

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface MarketConditionPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface MarketConditionPlugin

isPlanetary

public boolean isPlanetary()

Specified by:

isPlanetary in interface MarketConditionPlugin

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface MarketConditionPlugin

getIconName

public java.lang.String getIconName()

Specified by:

getIconName in interface MarketConditionPlugin

getName

public java.lang.String getName()

Specified by:

getName in interface MarketConditionPlugin