CargoStackAPI (Starfarer API)

```
public interface CargoStackAPI
```

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(float quantity)`
`int`	`getBaseValuePerUnit()`
`CargoAPI`	`getCargo()`
`float`	`getCargoSpace()`
`float`	`getCargoSpacePerUnit()`
`java.lang.String`	`getCommodityId()` Returns null if it's not a commodity stack.
`java.lang.Object`	`getData()` Usually a String.
`java.lang.String`	`getDisplayName()`
`FighterWingSpecAPI`	`getFighterWingSpecIfWing()`
`float`	`getFree()`
`HullModSpecAPI`	`getHullModSpecIfHullMod()`
`float`	`getMaxSize()`
`SpecialItemPlugin`	`getPlugin()` Returns a new instance of the plugin.
`CommoditySpecAPI`	`getResourceIfResource()`
`float`	`getSize()`
`SpecialItemData`	`getSpecialDataIfSpecial()`
`SpecialItemSpecAPI`	`getSpecialItemSpecIfSpecial()`
`CargoAPI.CargoItemType`	`getType()`
`WeaponSpecAPI`	`getWeaponSpecIfWeapon()`
`boolean`	`isCommodityStack()`
`boolean`	`isCrewStack()`
`boolean`	`isFighterWingStack()`
`boolean`	`isFuelStack()`
`boolean`	`isFull()`
`boolean`	`isInPlayerCargo()`
`boolean`	`isMarineStack()`
`boolean`	`isModSpecStack()` Deprecated.
`boolean`	`isNull()` If true, it's an empty cargo stack.
`boolean`	`isPersonnelStack()`
`boolean`	`isPickedUp()`
`boolean`	`isResourceStack()` Deprecated.
`boolean`	`isSpecialStack()`
`boolean`	`isSupplyStack()`
`boolean`	`isWeaponStack()`
`void`	`setCargo(CargoAPI cargo)`
`void`	`setPickedUp(boolean isPickedUp)`
`void`	`setSize(float size)`
`void`	`setType(CargoAPI.CargoItemType type)`
`void`	`subtract(float quantity)`

- Method Detail
  - isWeaponStack
```
boolean isWeaponStack()
```
  - isResourceStack
```
@Deprecated
boolean isResourceStack()
```
    Deprecated.
    
    Use isCommodityStack() instead.
    
    Returns:
  - isCommodityStack
```
boolean isCommodityStack()
```
  - isMarineStack
```
boolean isMarineStack()
```
  - isFuelStack
```
boolean isFuelStack()
```
  - isSupplyStack
```
boolean isSupplyStack()
```
  - isCrewStack
```
boolean isCrewStack()
```
  - isPersonnelStack
```
boolean isPersonnelStack()
```
  - getCommodityId
```
java.lang.String getCommodityId()
```
    Returns null if it's not a commodity stack.
    
    Returns:
  - getCargoSpace
```
float getCargoSpace()
```
  - getCargoSpacePerUnit
```
float getCargoSpacePerUnit()
```
  - getSize
```
float getSize()
```
  - getFree
```
float getFree()
```
  - setSize
```
void setSize(float size)
```
  - add
```
void add(float quantity)
```
  - subtract
```
void subtract(float quantity)
```
  - getMaxSize
```
float getMaxSize()
```
  - isFull
```
boolean isFull()
```
  - getType
```
CargoAPI.CargoItemType getType()
```
  - setType
```
void setType(CargoAPI.CargoItemType type)
```
  - isNull
```
boolean isNull()
```
    If true, it's an empty cargo stack. These get created for spacing, a result of the player moving cargo around.
    
    Returns:
  - getData
```
java.lang.Object getData()
```
    Usually a String. Its contents (i.e. the resource id) is how you can tell apart different types of resources.
    
    Returns:
  - getDisplayName
```
java.lang.String getDisplayName()
```
  - getCargo
```
CargoAPI getCargo()
```
    Returns:
    CargoAPI that contains this stack.
  - getBaseValuePerUnit
```
int getBaseValuePerUnit()
```
  - getWeaponSpecIfWeapon
```
WeaponSpecAPI getWeaponSpecIfWeapon()
```
  - isModSpecStack
```
@Deprecated
boolean isModSpecStack()
```
    Deprecated.
    
    Call isSpecialStack() and check specialData.getId().equals(Items.MODSPEC) instead.
    
    Returns:
  - isFighterWingStack
```
boolean isFighterWingStack()
```
  - getFighterWingSpecIfWing
```
FighterWingSpecAPI getFighterWingSpecIfWing()
```
  - getHullModSpecIfHullMod
```
HullModSpecAPI getHullModSpecIfHullMod()
```
  - getResourceIfResource
```
CommoditySpecAPI getResourceIfResource()
```
  - isSpecialStack
```
boolean isSpecialStack()
```
  - getSpecialDataIfSpecial
```
SpecialItemData getSpecialDataIfSpecial()
```
  - getSpecialItemSpecIfSpecial
```
SpecialItemSpecAPI getSpecialItemSpecIfSpecial()
```
  - getPlugin
```
SpecialItemPlugin 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:
  - setCargo
```
void setCargo(CargoAPI cargo)
```
  - isInPlayerCargo
```
boolean isInPlayerCargo()
```
  - isPickedUp
```
boolean isPickedUp()
```
  - setPickedUp
```
void setPickedUp(boolean isPickedUp)
```

Interface CargoStackAPI

Method Summary

Method Detail

isWeaponStack

isResourceStack

isCommodityStack

isMarineStack

isFuelStack

isSupplyStack

isCrewStack

isPersonnelStack

getCommodityId

getCargoSpace

getCargoSpacePerUnit

getSize

getFree

setSize

add

subtract

getMaxSize

isFull

getType

setType

isNull

getData

getDisplayName

getCargo

getBaseValuePerUnit

getWeaponSpecIfWeapon

isModSpecStack

isFighterWingStack

getFighterWingSpecIfWing

getHullModSpecIfHullMod

getResourceIfResource

isSpecialStack

getSpecialDataIfSpecial

getSpecialItemSpecIfSpecial

getPlugin

setCargo

isInPlayerCargo

isPickedUp

setPickedUp