Package com.fs.starfarer.api.campaign

Class PlayerMarketTransaction

java.lang.Object

com.fs.starfarer.api.campaign.PlayerMarketTransaction

public class PlayerMarketTransaction
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerMarketTransaction.LineItemType
static class	PlayerMarketTransaction.ShipSaleInfo
static class	PlayerMarketTransaction.TransactionLineItem

Constructor Summary

Constructors

Constructor	Description
PlayerMarketTransaction(MarketAPI market, SubmarketAPI submarket, CampaignUIAPI.CoreUITradeMode tradeMode)

Method Summary

Modifier and Type	Method	Description
float	getBaseTradeValueImpact()
CargoAPI	getBought()
float	getCreditValue()	Positive if the player received money, negative if they paid money.
List<PlayerMarketTransaction.TransactionLineItem>	getLineItems()	Only set for commodities (and possibly weapons) in non-free transactions.
MarketAPI	getMarket()
float	getQuantityBought(String commodityId)
float	getQuantitySold(String commodityId)
List<PlayerMarketTransaction.ShipSaleInfo>	getShipsBought()
List<PlayerMarketTransaction.ShipSaleInfo>	getShipsSold()
CargoAPI	getSold()
SubmarketAPI	getSubmarket()
CampaignUIAPI.CoreUITradeMode	getTradeMode()
void	setBought(CargoAPI bought)
void	setCreditValue(float creditValue)
void	setSold(CargoAPI sold)

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerMarketTransaction

public PlayerMarketTransaction(MarketAPI market,
 SubmarketAPI submarket,
 CampaignUIAPI.CoreUITradeMode tradeMode)

Method Details

getTradeMode

public CampaignUIAPI.CoreUITradeMode getTradeMode()

getLineItems

public List<PlayerMarketTransaction.TransactionLineItem> getLineItems()

Only set for commodities (and possibly weapons) in non-free transactions.

Returns:

getBaseTradeValueImpact

public float getBaseTradeValueImpact()

getCreditValue

public float getCreditValue()

Positive if the player received money, negative if they paid money. Only the net, so it's possible to have a very small value for a very large transaction.

Returns:

setCreditValue

public void setCreditValue(float creditValue)

getBought

public CargoAPI getBought()

setBought

public void setBought(CargoAPI bought)

getSold

public CargoAPI getSold()

setSold

public void setSold(CargoAPI sold)

getMarket

public MarketAPI getMarket()

getSubmarket

public SubmarketAPI getSubmarket()

getQuantityBought

public float getQuantityBought(String commodityId)

getQuantitySold

public float getQuantitySold(String commodityId)

getShipsBought

public List<PlayerMarketTransaction.ShipSaleInfo> getShipsBought()

getShipsSold

public List<PlayerMarketTransaction.ShipSaleInfo> getShipsSold()