Resource Transfer¶

Structure¶

structure ResourceTransfer¶

Members¶

Suffix	Type (units)	Access	Description
STATUS	string	Get only	The string status of the transfer (eg “Inactive”, “Transferring”, “Failed”, “Finished”)
MESSAGE	string	Get only	A message about the current status
GOAL	scalar	Get only	This is how much of the resource will be transferred.
TRANSFERRED	scalar	Get only	This is how much of the resource has been transferred.
RESOURCE	string	Get only	The name of the resource (eg oxidizer, liquidfuel)
ACTIVE	boolean	Get / Set	Setting this value will either start, pause or restart a transfer. Default is false.

RESOURCETRANSFER:STATUS¶

Access:	Get only
Type:	string

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:MESSAGE¶

Access:	Get only
Type:	string

This shows the detail related to STATUS

RESOURCETRANSFER:GOAL¶

Access:	Get only
Type:	scalar

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:	scalar

Returns the amount of the specified resource that has been transferred by this resource transfer.

RESOURCETRANSFER:RESOURCE¶

Access:	Get only
Type:	string

The name of the resource that will be transferred. (eg, oxidizer, liquidfuel)

RESOURCETRANSFER:ACTIVE¶

Access:	Get / Set
Type:	boolean

When getting, this suffix is simply a shortcut to tell you if STATUS is Transferring. Setting true will change the status of the transfer to Transferring, setting false will change status to inactive.