Resource Transfer¶
Usage is covered elsewhere <../commands/resource_transfer.html>`__
Structure¶
- structure ResourceTransfer¶
¶ Suffix
Type (units)
Access
Description
Get only
The
String
status of the transfer (eg “Inactive”, “Transferring”, “Failed”, “Finished”)Get only
A message about the current status
Get only
This is how much of the resource will be transferred.
Get only
This is how much of the resource has been transferred.
Get only
The name of the resource (eg oxidizer, liquidfuel)
Get / Set
Setting this value will either start, pause or restart a transfer. Default is false.
- RESOURCETRANSFER:STATUS¶
- Access
Get only
- Type
This enumerated type shows the status of the transfer. the possible values are:
- Inactive (default)
Transfer is stopped
- Finished
Transfer has reached its goal
- Failed
There was an error in the transfer, see
MESSAGE
for details
- Transferring
The transfer is in progress.
- RESOURCETRANSFER:GOAL¶
- Access
Get only
- Type
If you specified an amount to transfer in your transfer request, it will be shown here. If you did not, this will return the sentinel value -1.
- RESOURCETRANSFER:TRANSFERRED¶
- Access
Get only
- Type
Returns the amount of the specified resource that has been transferred by this resource transfer.
- RESOURCETRANSFER:RESOURCE¶
- Access
Get only
- Type
The name of the resource that will be transferred. (eg, oxidizer, liquidfuel)