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

Class ShippingDisruption

java.lang.Object

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

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

All Implemented Interfaces:

MarketConditionPlugin

public class ShippingDisruption
extends BaseMarketConditionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static float	ACCESS_LOSS_DURATION
static float	ACCESS_PER_UNITS_LOST
static java.lang.String	COMMODITY_LOSS_PREFIX
protected float	disruptionTimeLeft
protected MutableStatWithTempMods	shippingLost

Fields inherited from class com.fs.starfarer.api.impl.campaign.econ.BaseMarketConditionPlugin

condition, market

Constructor Summary

Constructors

Constructor and Description
ShippingDisruption()

Method Summary

Modifier and Type	Method and Description
void	addShippingLost(float units) "units" is the largest number of econ-units of a commodity being carried by a trade fleet.
void	advance(float amount)
void	apply(java.lang.String id)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
static ShippingDisruption	getDisruption(MarketAPI market)
float	getDisruptionTimeLeft()
java.lang.String[]	getHighlights() For the description, which is shown in the tooltip.
static float	getPenaltyForShippingLost(float marketSize, float unitsLost)
java.util.Map<java.lang.String,java.lang.String>	getTokenReplacements() For the description that shows up in the tooltip.
float	getTooltipWidth()
boolean	hasCustomTooltip()
boolean	isTooltipExpandable()
boolean	isTransient() Return false if the plugin has data that needs to be in the savefile.
void	notifyDisrupted(float duration)
void	setDisruptionTimeLeft(float disruptionTimeLeft)
void	unapply(java.lang.String id)
protected void	updatePenaltyValue()

Methods inherited from class com.fs.starfarer.api.impl.campaign.econ.BaseMarketConditionPlugin

addTokensToList, createTooltipAfterDescription, getHighlightColors, getHighStabilityBonusMult, getHighStabilityPenaltyMult, getIconName, getLowStabilityBonusMult, getLowStabilityPenaltyMult, getModId, getName, getRelatedCommodities, init, isPlanetary, main, runWhilePaused, setParam, showIcon

Methods inherited from class java.lang.Object

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

Field Detail

COMMODITY_LOSS_PREFIX

public static java.lang.String COMMODITY_LOSS_PREFIX

ACCESS_LOSS_DURATION

public static float ACCESS_LOSS_DURATION

ACCESS_PER_UNITS_LOST

public static float ACCESS_PER_UNITS_LOST

shippingLost

protected MutableStatWithTempMods shippingLost

disruptionTimeLeft

protected float disruptionTimeLeft

Constructor Detail

ShippingDisruption

public ShippingDisruption()

Method Detail

getPenaltyForShippingLost

public static float getPenaltyForShippingLost(float marketSize,
                                              float unitsLost)

getDisruption

public static ShippingDisruption getDisruption(MarketAPI market)

addShippingLost

public void addShippingLost(float units)

"units" is the largest number of econ-units of a commodity being carried by a trade fleet. For example, 5 food, 3 organics, 2 fuel = 5 units = approximate "size" of that trade fleet, in economy terms.

Parameters:

units -

updatePenaltyValue

protected void updatePenaltyValue()

getDisruptionTimeLeft

public float getDisruptionTimeLeft()

setDisruptionTimeLeft

public void setDisruptionTimeLeft(float disruptionTimeLeft)

notifyDisrupted

public void notifyDisrupted(float duration)

apply

public void apply(java.lang.String id)

Specified by:

apply in interface MarketConditionPlugin

Overrides:

apply in class BaseMarketConditionPlugin

unapply

public void unapply(java.lang.String id)

Specified by:

unapply in interface MarketConditionPlugin

Overrides:

unapply in class BaseMarketConditionPlugin

advance

public void advance(float amount)

Specified by:

advance in interface MarketConditionPlugin

Overrides:

advance in class BaseMarketConditionPlugin

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

Overrides:

getTokenReplacements in class BaseMarketConditionPlugin

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

Overrides:

getHighlights in class BaseMarketConditionPlugin

Returns:

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

Overrides:

isTransient in class BaseMarketConditionPlugin

Returns:

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface MarketConditionPlugin

Overrides:

createTooltip in class BaseMarketConditionPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface MarketConditionPlugin

Overrides:

getTooltipWidth in class BaseMarketConditionPlugin

hasCustomTooltip

public boolean hasCustomTooltip()

Specified by:

hasCustomTooltip in interface MarketConditionPlugin

Overrides:

hasCustomTooltip in class BaseMarketConditionPlugin

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface MarketConditionPlugin

Overrides:

isTooltipExpandable in class BaseMarketConditionPlugin