Module PlasmaExtractorUnit

Extracts a regular amount of plasma from the space surrounding an alien core.

Note: This is generated from patch notes and in-game codex and has not yet been tested against the actual element. Accuracy not guaranteed.

Element class: ???

Extends: Element

Functions

getState () Returns the current state of the plasma extractor.
getRemainingTime () Returns the remaining time of the current batch extraction process.
getPlasmaPools () Returns the list of available plasma pools.
EVENT_onStarted () Event: Emitted when the plasma extractor started a new extraction process.
EVENT_onCompleted () Event: Emitted when the plasma extractor completes a batch.
EVENT_onStateChanged (state) Event: Emitted when the plasma extractor state is changed.
EVENT_onStopped () Event: Emitted when the plasma extractor stopped the extraction process.


Functions

getState ()
Returns the current state of the plasma extractor.

Returns:

    int The state of the plasma extractor can be (Stopped = 1, Running = 2, Jammed output full = 3, Jammed no output container = 4)
getRemainingTime ()
Returns the remaining time of the current batch extraction process.

Returns:

    float The remaining time in seconds.
getPlasmaPools ()
Returns the list of available plasma pools.

Returns:

    table A list of tables composed with {[int] oreId, [int] quantity}.
EVENT_onStarted ()
Event: Emitted when the plasma extractor started a new extraction process.

Note: This is documentation on an event handler, not a callable method.

EVENT_onCompleted ()
Event: Emitted when the plasma extractor completes a batch.

Note: This is documentation on an event handler, not a callable method.

EVENT_onStateChanged (state)
Event: Emitted when the plasma extractor state is changed.

Note: This is documentation on an event handler, not a callable method.

Parameters:

  • state int The state of the plasma extractor can be (Stopped = 1, Running = 2, Jammed output full = 3, Jammed no output container = 4)
EVENT_onStopped ()
Event: Emitted when the plasma extractor stopped the extraction process.

Note: This is documentation on an event handler, not a callable method.

generated by LDoc 1.5.0 Last updated 2023-09-04 19:09:50