Resources#

class Resources#

Represents the collection of resources stored in a vessel, stage or part. Created by calling Vessel.resources, Stage.resources(), EditorVessel.resources or Part.resources.

all#

All the individual resources that can be stored.

Attribute:: Read-only, cannot be set
Return type:: list(Resource)
Game Scenes:: Flight, Editor Vab, Editor Sph

with_resource(name)#

All the individual resources with the given name that can be stored.

Parameters:: name (str)
Return type:: list(Resource)
Game Scenes:: Flight, Editor Vab, Editor Sph

names#

A list of resource names that can be stored.

Attribute:: Read-only, cannot be set
Return type:: list(str)
Game Scenes:: Flight, Editor Vab, Editor Sph

has_resource(name)#

Check whether the named resource can be stored.

Parameters:: name (str) – The name of the resource.
Return type:: bool
Game Scenes:: Flight, Editor Vab, Editor Sph

amount(name)#

Returns the amount of a resource that is currently stored.

Parameters:: name (str) – The name of the resource.
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

max(name)#

Returns the amount of a resource that can be stored.

Parameters:: name (str) – The name of the resource.
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

static density(name)#

Returns the density of a resource, in \(kg/l\).

Parameters:: name (str) – The name of the resource.
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

static flow_mode(name)#

Returns the flow mode of a resource.

Parameters:: name (str) – The name of the resource.
Return type:: ResourceFlowMode
Game Scenes:: Flight, Editor Vab, Editor Sph

enabled#

Whether use of all the resources are enabled.

Attribute:: Can be read or written
Return type:: bool
Game Scenes:: Flight, Editor Vab, Editor Sph

Note

This is True if all of the resources are enabled. If any of the resources are not enabled, this is False.

class Resource#

An individual resource stored within a part. Created using methods in the Resources class.

name#

The name of the resource.

Attribute:: Read-only, cannot be set
Return type:: str
Game Scenes:: Flight, Editor Vab, Editor Sph

part#

The part containing the resource.

Attribute:: Read-only, cannot be set
Return type:: Part
Game Scenes:: Flight, Editor Vab, Editor Sph

amount#

The amount of the resource that is currently stored in the part.

Attribute:: Read-only, cannot be set
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

max#

The total amount of the resource that can be stored in the part.

Attribute:: Read-only, cannot be set
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

density#

The density of the resource, in \(kg/l\).

Attribute:: Read-only, cannot be set
Return type:: float
Game Scenes:: Flight, Editor Vab, Editor Sph

flow_mode#

The flow mode of the resource.

Attribute:: Read-only, cannot be set
Return type:: ResourceFlowMode
Game Scenes:: Flight, Editor Vab, Editor Sph

enabled#

Whether use of this resource is enabled.

Attribute:: Can be read or written
Return type:: bool
Game Scenes:: Flight, Editor Vab, Editor Sph

class ResourceTransfer#

Transfer resources between parts.

static start(from_part, to_part, resource, max_amount)#

Start transferring a resource transfer between a pair of parts. The transfer will move at most max_amount units of the resource, depending on how much of the resource is available in the source part and how much storage is available in the destination part. Use ResourceTransfer.complete to check if the transfer is complete. Use ResourceTransfer.amount to see how much of the resource has been transferred.

Parameters:

from_part (Part) – The part to transfer to.
to_part (Part) – The part to transfer from.
resource (str) – The name of the resource to transfer.
max_amount (float) – The maximum amount of resource to transfer.

Return type:

ResourceTransfer

Note

Use ResourceTransfer.cancel() to stop the transfer before it finishes; a canceled transfer is marked as complete. Use ResourceTransfer.remove() to release the memory the server holds for a transfer that is done with. A transfer is stopped and removed if the client that started it disconnects, or if the flight it runs in is left.

cancel()#: Cancel the transfer. No more of the resource is moved and ResourceTransfer.complete becomes true.

remove()#: Remove the transfer, releasing the memory the server holds for it. The transfer is canceled if it has not finished.

Note

Any further use of this object throws an exception. A transfer that is left is held until the parts it runs between are gone, the flight it runs in is left, or the client that started it disconnects, whichever comes first; the first of those may be the rest of the flight away.

amount#

The amount of the resource that has been transferred.

Attribute:: Read-only, cannot be set
Return type:: float

complete#

Whether the transfer has completed. Also becomes true if the transfer is canceled by calling ResourceTransfer.cancel().

Attribute:: Read-only, cannot be set
Return type:: bool

class ResourceFlowMode#

The way in which a resource flows between parts. See Resources.flow_mode().

vessel#: The resource flows to any part in the vessel. For example, electric charge.

stage#: The resource flows from parts in the first stage, followed by the second, and so on. For example, mono-propellant.

adjacent#: The resource flows between adjacent parts within the vessel. For example, liquid fuel or oxidizer.

none#: The resource does not flow. For example, solid fuel.