Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.campaign.CargoAPI Interface Reference

Classes

class  CargoItemQuantity
 
enum  CargoItemType
 

Public Member Functions

List< CargoItemQuantity< String > > getWeapons ()
 
int getNumWeapons (String id)
 
void removeWeapons (String id, int count)
 
void addWeapons (String id, int count)
 
float getSupplies ()
 
float getFuel ()
 
int getTotalCrew ()
 
void addCrew (int quantity)
 
int getCrew ()
 
int getMarines ()
 
void addMarines (int quantity)
 
void removeMarines (int quantity)
 
void addFuel (float quantity)
 
void removeFuel (float quantity)
 
void addSupplies (float quantity)
 
void removeSupplies (float quantity)
 
void removeCrew (int quantity)
 
void addItems (CargoAPI.CargoItemType itemType, Object data, float quantity)
 
boolean removeItems (CargoAPI.CargoItemType itemType, Object data, float quantity)
 
float getQuantity (CargoAPI.CargoItemType type, Object data)
 
void addMothballedShip (FleetMemberType type, String variantOrWingId, String optionalName)
 
void initMothballedShips (String factionId)
 
FleetDataAPI getMothballedShips ()
 
void clear ()
 
void setFreeTransfer (boolean freeTransfer)
 
boolean isFreeTransfer ()
 
MutableValue getCredits ()
 
List< CargoStackAPIgetStacksCopy ()
 
void gainCrewXP (float xp)
 
void sort ()
 
float getMaxFuel ()
 
float getMaxCapacity ()
 
float getMaxPersonnel ()
 
float getSpaceUsed ()
 
float getSpaceLeft ()
 
boolean isEmpty ()
 
void removeEmptyStacks ()
 
void addFromStack (CargoStackAPI stack)
 
void addCommodity (String commodityId, float quantity)
 
float getCommodityQuantity (String id)
 
int getTotalPersonnel ()
 
void removeCommodity (String id, float quantity)
 
void removeStack (CargoStackAPI stack)
 
List< CargoItemQuantity< String > > getFighters ()
 
int getNumFighters (String id)
 
void addAll (CargoAPI other)
 
void addFighters (String id, int count)
 
void addHullmods (String id, int count)
 
int getFreeCrewSpace ()
 
int getFreeFuelSpace ()
 
void addSpecial (SpecialItemData data, float quantity)
 
CargoAPI createCopy ()
 
void initPartialsIfNeeded ()
 
void removeAll (CargoAPI other)
 
void addAll (CargoAPI other, boolean includeMothballedShips)
 
CargoAPI getOrigSource ()
 
void setOrigSource (CargoAPI origSource)
 
FleetDataAPI getFleetData ()
 
void updateSpaceUsed ()
 
void removeFighters (String id, int count)
 
boolean isUnlimitedStacks ()
 
void setUnlimitedStacks (boolean unlimitedStacks)
 

Detailed Description

Author
Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 13 of file CargoAPI.java.

Member Function Documentation

◆ addAll() [1/2]

void com.fs.starfarer.api.campaign.CargoAPI.addAll ( CargoAPI other)

◆ addAll() [2/2]

void com.fs.starfarer.api.campaign.CargoAPI.addAll ( CargoAPI other,
boolean includeMothballedShips )

◆ addCommodity()

void com.fs.starfarer.api.campaign.CargoAPI.addCommodity ( String commodityId,
float quantity )

◆ addCrew()

void com.fs.starfarer.api.campaign.CargoAPI.addCrew ( int quantity)

◆ addFighters()

void com.fs.starfarer.api.campaign.CargoAPI.addFighters ( String id,
int count )

◆ addFromStack()

void com.fs.starfarer.api.campaign.CargoAPI.addFromStack ( CargoStackAPI stack)

◆ addFuel()

void com.fs.starfarer.api.campaign.CargoAPI.addFuel ( float quantity)

◆ addHullmods()

void com.fs.starfarer.api.campaign.CargoAPI.addHullmods ( String id,
int count )

◆ addItems()

void com.fs.starfarer.api.campaign.CargoAPI.addItems ( CargoAPI.CargoItemType itemType,
Object data,
float quantity )

◆ addMarines()

void com.fs.starfarer.api.campaign.CargoAPI.addMarines ( int quantity)

◆ addMothballedShip()

void com.fs.starfarer.api.campaign.CargoAPI.addMothballedShip ( FleetMemberType type,
String variantOrWingId,
String optionalName )

◆ addSpecial()

void com.fs.starfarer.api.campaign.CargoAPI.addSpecial ( SpecialItemData data,
float quantity )

◆ addSupplies()

void com.fs.starfarer.api.campaign.CargoAPI.addSupplies ( float quantity)

◆ addWeapons()

void com.fs.starfarer.api.campaign.CargoAPI.addWeapons ( String id,
int count )

◆ clear()

void com.fs.starfarer.api.campaign.CargoAPI.clear ( )

◆ createCopy()

CargoAPI com.fs.starfarer.api.campaign.CargoAPI.createCopy ( )

◆ gainCrewXP()

void com.fs.starfarer.api.campaign.CargoAPI.gainCrewXP ( float xp)

◆ getCommodityQuantity()

float com.fs.starfarer.api.campaign.CargoAPI.getCommodityQuantity ( String id)

◆ getCredits()

MutableValue com.fs.starfarer.api.campaign.CargoAPI.getCredits ( )

◆ getCrew()

int com.fs.starfarer.api.campaign.CargoAPI.getCrew ( )

◆ getFighters()

List< CargoItemQuantity< String > > com.fs.starfarer.api.campaign.CargoAPI.getFighters ( )

◆ getFleetData()

FleetDataAPI com.fs.starfarer.api.campaign.CargoAPI.getFleetData ( )

◆ getFreeCrewSpace()

int com.fs.starfarer.api.campaign.CargoAPI.getFreeCrewSpace ( )

◆ getFreeFuelSpace()

int com.fs.starfarer.api.campaign.CargoAPI.getFreeFuelSpace ( )

◆ getFuel()

float com.fs.starfarer.api.campaign.CargoAPI.getFuel ( )

◆ getMarines()

int com.fs.starfarer.api.campaign.CargoAPI.getMarines ( )

◆ getMaxCapacity()

float com.fs.starfarer.api.campaign.CargoAPI.getMaxCapacity ( )

◆ getMaxFuel()

float com.fs.starfarer.api.campaign.CargoAPI.getMaxFuel ( )

◆ getMaxPersonnel()

float com.fs.starfarer.api.campaign.CargoAPI.getMaxPersonnel ( )

◆ getMothballedShips()

FleetDataAPI com.fs.starfarer.api.campaign.CargoAPI.getMothballedShips ( )

Call initMothballedShips(String factionId) before using this method.

Returns

◆ getNumFighters()

int com.fs.starfarer.api.campaign.CargoAPI.getNumFighters ( String id)

◆ getNumWeapons()

int com.fs.starfarer.api.campaign.CargoAPI.getNumWeapons ( String id)

◆ getOrigSource()

CargoAPI com.fs.starfarer.api.campaign.CargoAPI.getOrigSource ( )

◆ getQuantity()

float com.fs.starfarer.api.campaign.CargoAPI.getQuantity ( CargoAPI.CargoItemType type,
Object data )

◆ getSpaceLeft()

float com.fs.starfarer.api.campaign.CargoAPI.getSpaceLeft ( )

◆ getSpaceUsed()

float com.fs.starfarer.api.campaign.CargoAPI.getSpaceUsed ( )

◆ getStacksCopy()

List< CargoStackAPI > com.fs.starfarer.api.campaign.CargoAPI.getStacksCopy ( )

◆ getSupplies()

float com.fs.starfarer.api.campaign.CargoAPI.getSupplies ( )

◆ getTotalCrew()

int com.fs.starfarer.api.campaign.CargoAPI.getTotalCrew ( )

◆ getTotalPersonnel()

int com.fs.starfarer.api.campaign.CargoAPI.getTotalPersonnel ( )

◆ getWeapons()

List< CargoItemQuantity< String > > com.fs.starfarer.api.campaign.CargoAPI.getWeapons ( )

◆ initMothballedShips()

void com.fs.starfarer.api.campaign.CargoAPI.initMothballedShips ( String factionId)

◆ initPartialsIfNeeded()

void com.fs.starfarer.api.campaign.CargoAPI.initPartialsIfNeeded ( )

◆ isEmpty()

boolean com.fs.starfarer.api.campaign.CargoAPI.isEmpty ( )

◆ isFreeTransfer()

boolean com.fs.starfarer.api.campaign.CargoAPI.isFreeTransfer ( )

◆ isUnlimitedStacks()

boolean com.fs.starfarer.api.campaign.CargoAPI.isUnlimitedStacks ( )

◆ removeAll()

void com.fs.starfarer.api.campaign.CargoAPI.removeAll ( CargoAPI other)

◆ removeCommodity()

void com.fs.starfarer.api.campaign.CargoAPI.removeCommodity ( String id,
float quantity )

◆ removeCrew()

void com.fs.starfarer.api.campaign.CargoAPI.removeCrew ( int quantity)

◆ removeEmptyStacks()

void com.fs.starfarer.api.campaign.CargoAPI.removeEmptyStacks ( )

◆ removeFighters()

void com.fs.starfarer.api.campaign.CargoAPI.removeFighters ( String id,
int count )

◆ removeFuel()

void com.fs.starfarer.api.campaign.CargoAPI.removeFuel ( float quantity)

◆ removeItems()

boolean com.fs.starfarer.api.campaign.CargoAPI.removeItems ( CargoAPI.CargoItemType itemType,
Object data,
float quantity )

◆ removeMarines()

void com.fs.starfarer.api.campaign.CargoAPI.removeMarines ( int quantity)

◆ removeStack()

void com.fs.starfarer.api.campaign.CargoAPI.removeStack ( CargoStackAPI stack)

◆ removeSupplies()

void com.fs.starfarer.api.campaign.CargoAPI.removeSupplies ( float quantity)

◆ removeWeapons()

void com.fs.starfarer.api.campaign.CargoAPI.removeWeapons ( String id,
int count )

◆ setFreeTransfer()

void com.fs.starfarer.api.campaign.CargoAPI.setFreeTransfer ( boolean freeTransfer)

Use SectorEntityToken.setFreeTransfer() instead. Whether moving items to and from this entity has a cost.

Parameters
freeTransfer

◆ setOrigSource()

void com.fs.starfarer.api.campaign.CargoAPI.setOrigSource ( CargoAPI origSource)

◆ setUnlimitedStacks()

void com.fs.starfarer.api.campaign.CargoAPI.setUnlimitedStacks ( boolean unlimitedStacks)

◆ sort()

void com.fs.starfarer.api.campaign.CargoAPI.sort ( )

◆ updateSpaceUsed()

void com.fs.starfarer.api.campaign.CargoAPI.updateSpaceUsed ( )

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