space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.SpaceCenter.ResourceConverter

A resource converter.

Obtained by calling SpaceEx.SpaceCenter.Part.resource_converter/1.

Link to this section Summary

Functions

active(this, index)

True if the specified converter is active

count(this)

The number of converters in the part

inputs(this, index)

List of the names of resources consumed by the specified converter

name(this, index)

The name of the specified converter

outputs(this, index)

List of the names of resources produced by the specified converter

part(this)

The part object for this converter

start(this, index)

Start the specified converter

state(this, index)

The state of the specified converter

status_info(this, index)

Status information for the specified converter

stop(this, index)

Stop the specified converter

Link to this section Functions

Link to this function active(this, index)

True if the specified converter is active.

  • index — Index of the converter.

Returns: true or false

Link to this function count(this)

The number of converters in the part.

Returns: an integer

Link to this function inputs(this, index)

List of the names of resources consumed by the specified converter.

  • index — Index of the converter.

Returns: [str, ...], where str is a string

Link to this function name(this, index)

The name of the specified converter.

  • index — Index of the converter.

Returns: a string

Link to this function outputs(this, index)

List of the names of resources produced by the specified converter.

  • index — Index of the converter.

Returns: [str, ...], where str is a string

Link to this function part(this)

The part object for this converter.

Returns: a reference to a SpaceEx.SpaceCenter.Part object

Link to this function start(this, index)

Start the specified converter.

  • index — Index of the converter.

Returns: :ok

Link to this function state(this, index)

The state of the specified converter.

  • index — Index of the converter.

Returns: a Elixir.SpaceEx.SpaceCenter.ResourceConverterState value in atom form

Link to this function status_info(this, index)

Status information for the specified converter.

This is the full status message shown in the in-game UI.

  • index — Index of the converter.

Returns: a string

Link to this function stop(this, index)

Stop the specified converter.

  • index — Index of the converter.

Returns: :ok