[skip|else] if [not]|while [not]| = The possible 'Conditional' statements that can be used with this command.
<RetVar/IF> = If the command is to 'return' information.
<RefObj> = The 'Object' that the command is to be run on. This object can only be a 'Ship' or 'Station'.
<Var/Ware> = (WareType) The ware to be checked for available space.
This command will check the <RefObj> for how much of the selected <Var/Ware> can fit into the current free cargo space. The returned amount will be rounded down to the max amount of whole units that can fit into the cargo bay.
For Ships;
If a ship is being checked it will check the available free cargo space. It will also take into account ware transport size, if the ship can not transport that size ware it will return '0' (Zero) free space.
For Stations;
If a Station is being checked it will allow for the 'Defined' amount of ware that station can hold of that particular ware and report on only the space available for that ware.
Example:
$max.amount = $ship get free volume of ware Energy Cells in cargo bay
This will return the maximum amount of Energy Cells that will fit into the cargo bay of $ship. It will automatically allow for any space already taken up in the cargo bay by other items.
Command Location:
- »» Trade Commands
- »» for Ships and Stations
<RetVar/IF><RefObj> get free volume of ware <Var/Ware> in cargo bay
- »» for Ships and Stations