com.fs.starfarer.api.campaign.econ

Interface MarketConditionPlugin

All Known Implementing Classes:

AbandonedStation, AICoreAdmin, BaseHazardCondition, BaseMarketConditionPlugin, BaseMarketConditionPlugin2, Blockaded, ClosedImmigration, CommRelayCondition, CottageIndustry, Decivilized, DecivilizedSubpop, Dissident, EstablishedPolity, FoodShortage, FreeMarket, Frontier, Habitable, Headquarters, HighGravity, HostileActivity, Hydroponics, IndustrialPolity, LargeRefugeePopulation, LCAttractorHigh, LCAttractorLow, LCAttractorMedium, LowGravity, LuddicMajority, LuddicPathCells, MildClimate, OrbitalBurns, OrganizedCrime, Outpost, PiracyRespite, PirateActivity, Placeholder, Pollution, Population, RecentUnrest, RegionalCapital, ResourceDepositsCondition, RogueAICore, RuralPolity, ShipbreakingCenter, ShippingDisruption, Smuggling, SolarArray, StealthMinefields, SystemBounty, TradeCenter, TradeDisruption, UrbanizedPolity, ViceDemand, WorldArid, WorldBarrenMarginal, WorldDesert, WorldFarming, WorldIce, WorldJungle, WorldTerran, WorldTundra, WorldTwilight, WorldUninhabitable, WorldWater

public interface MarketConditionPlugin

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	apply(java.lang.String id)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.awt.Color[]	getHighlightColors()
java.lang.String[]	getHighlights() For the description, which is shown in the tooltip.
java.lang.String	getIconName()
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.
boolean	runWhilePaused()
void	setParam(java.lang.Object param)
boolean	showIcon()
void	unapply(java.lang.String id)

Method Detail

advance

void advance(float amount)

init

void init(MarketAPI market,
          MarketConditionAPI condition)

apply

void apply(java.lang.String id)

unapply

void unapply(java.lang.String id)

getRelatedCommodities

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

Only used for conditions that come from events.

Returns:

getTokenReplacements

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

For the description that shows up in the tooltip.

Returns:

getHighlights

java.lang.String[] getHighlights()

For the description, which is shown in the tooltip.

Returns:

getHighlightColors

java.awt.Color[] getHighlightColors()

setParam

void setParam(java.lang.Object param)

isTransient

boolean isTransient()

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

Returns:

showIcon

boolean showIcon()

isPlanetary

boolean isPlanetary()

hasCustomTooltip

boolean hasCustomTooltip()

createTooltip

void createTooltip(TooltipMakerAPI tooltip,
                   boolean expanded)

isTooltipExpandable

boolean isTooltipExpandable()

getTooltipWidth

float getTooltipWidth()

runWhilePaused

boolean runWhilePaused()

getName

java.lang.String getName()

getIconName

java.lang.String getIconName()