com.fs.starfarer.api.campaign.CargoStackAPI Interface Reference

Public Member Functions
boolean	isWeaponStack ()
boolean	isResourceStack ()
boolean	isCommodityStack ()
boolean	isMarineStack ()
boolean	isFuelStack ()
boolean	isSupplyStack ()
boolean	isCrewStack ()
boolean	isPersonnelStack ()
String	getCommodityId ()
float	getCargoSpace ()
float	getCargoSpacePerUnit ()
float	getSize ()
float	getFree ()
void	setSize (float size)
void	add (float quantity)
void	subtract (float quantity)
float	getMaxSize ()
boolean	isFull ()
CargoAPI.CargoItemType	getType ()
void	setType (CargoAPI.CargoItemType type)
boolean	isNull ()
Object	getData ()
String	getDisplayName ()
CargoAPI	getCargo ()
int	getBaseValuePerUnit ()
WeaponSpecAPI	getWeaponSpecIfWeapon ()
boolean	isModSpecStack ()
boolean	isFighterWingStack ()
FighterWingSpecAPI	getFighterWingSpecIfWing ()
HullModSpecAPI	getHullModSpecIfHullMod ()
CommoditySpecAPI	getResourceIfResource ()
boolean	isSpecialStack ()
SpecialItemData	getSpecialDataIfSpecial ()
SpecialItemSpecAPI	getSpecialItemSpecIfSpecial ()
SpecialItemPlugin	getPlugin ()
void	setCargo (CargoAPI cargo)
boolean	isInPlayerCargo ()
boolean	isPickedUp ()
void	setPickedUp (boolean isPickedUp)

Detailed Description

Definition at line 9 of file CargoStackAPI.java.

Member Function Documentation

add()

void com.fs.starfarer.api.campaign.CargoStackAPI.add

(

float

quantity

)

getBaseValuePerUnit()

int com.fs.starfarer.api.campaign.CargoStackAPI.getBaseValuePerUnit

(

)

getCargo()

CargoAPI com.fs.starfarer.api.campaign.CargoStackAPI.getCargo

(

)

Returns

CargoAPI that contains this stack.

getCargoSpace()

float com.fs.starfarer.api.campaign.CargoStackAPI.getCargoSpace

(

)

getCargoSpacePerUnit()

float com.fs.starfarer.api.campaign.CargoStackAPI.getCargoSpacePerUnit

(

)

getCommodityId()

String com.fs.starfarer.api.campaign.CargoStackAPI.getCommodityId

(

)

Returns null if it's not a commodity stack.

Returns

getData()

Object com.fs.starfarer.api.campaign.CargoStackAPI.getData

(

)

Usually a String. Its contents (i.e. the resource id) is how you can tell apart different types of resources.

Returns

getDisplayName()

String com.fs.starfarer.api.campaign.CargoStackAPI.getDisplayName

(

)

getFighterWingSpecIfWing()

FighterWingSpecAPI com.fs.starfarer.api.campaign.CargoStackAPI.getFighterWingSpecIfWing

(

)

getFree()

float com.fs.starfarer.api.campaign.CargoStackAPI.getFree

(

)

getHullModSpecIfHullMod()

HullModSpecAPI com.fs.starfarer.api.campaign.CargoStackAPI.getHullModSpecIfHullMod

(

)

getMaxSize()

float com.fs.starfarer.api.campaign.CargoStackAPI.getMaxSize

(

)

getPlugin()

SpecialItemPlugin com.fs.starfarer.api.campaign.CargoStackAPI.getPlugin

(

)

Returns a new instance of the plugin. The special item plugin is transient and many instances may be in existence at any time - i.e. one for rendering the item in cargo, one for creating the tooltip, one for executing a right-click action, etc.

Returns

getResourceIfResource()

CommoditySpecAPI com.fs.starfarer.api.campaign.CargoStackAPI.getResourceIfResource

(

)

getSize()

float com.fs.starfarer.api.campaign.CargoStackAPI.getSize

(

)

getSpecialDataIfSpecial()

SpecialItemData com.fs.starfarer.api.campaign.CargoStackAPI.getSpecialDataIfSpecial

(

)

getSpecialItemSpecIfSpecial()

SpecialItemSpecAPI com.fs.starfarer.api.campaign.CargoStackAPI.getSpecialItemSpecIfSpecial

(

)

getType()

CargoAPI.CargoItemType com.fs.starfarer.api.campaign.CargoStackAPI.getType

(

)

getWeaponSpecIfWeapon()

WeaponSpecAPI com.fs.starfarer.api.campaign.CargoStackAPI.getWeaponSpecIfWeapon

(

)

isCommodityStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isCommodityStack

(

)

isCrewStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isCrewStack

(

)

isFighterWingStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isFighterWingStack

(

)

isFuelStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isFuelStack

(

)

isFull()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isFull

(

)

isInPlayerCargo()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isInPlayerCargo

(

)

isMarineStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isMarineStack

(

)

isModSpecStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isModSpecStack

(

)

Call isSpecialStack() and check specialData.getId().equals(Items.MODSPEC) instead.

Returns

isNull()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isNull

(

)

If true, it's an empty cargo stack. These get created for spacing, a result of the player moving cargo around.

Returns

isPersonnelStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isPersonnelStack

(

)

isPickedUp()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isPickedUp

(

)

isResourceStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isResourceStack

(

)

Use isCommodityStack() instead.

Returns

isSpecialStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isSpecialStack

(

)

isSupplyStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isSupplyStack

(

)

isWeaponStack()

boolean com.fs.starfarer.api.campaign.CargoStackAPI.isWeaponStack

(

)

setCargo()

void com.fs.starfarer.api.campaign.CargoStackAPI.setCargo

(

CargoAPI

cargo

)

setPickedUp()

void com.fs.starfarer.api.campaign.CargoStackAPI.setPickedUp

(

boolean

isPickedUp

)

setSize()

void com.fs.starfarer.api.campaign.CargoStackAPI.setSize

(

float

size

)

setType()

void com.fs.starfarer.api.campaign.CargoStackAPI.setType

(

CargoAPI.CargoItemType

type

)

subtract()

void com.fs.starfarer.api.campaign.CargoStackAPI.subtract

(

float

quantity

)

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/campaign/CargoStackAPI.java