OutputAdapter API Source

OutputAdapter is an abstract class that functions as a metric consumer. Typically, an OutputAdapter implementation will accept one or more parameters to its constructor method. These properties define what targets and/or peripherals it should interact with when write() is called.

Properties

Name	Type	Default
components 🔒 (set by subclass)	{ [string]: table }	{}
Dictionary of assigned peripherals.

Methods

OutputAdapter

Creates a new OutputAdapter instance.

DANGER

Because OutputAdapter is an abstract class, this constructor should only be called from within classes inheriting OutputAdapter by calling self:super('constructor'). This will set up any inherited properties with the correct default values. Behavior of any other use is undefined.

setBoot

OutputAdapter:setBoot (proc: fun()): fun()

Sets the boot() function called at the top of write() and returns it. This should usually be used to prepare a function that reattaches any peripherals that may have changed states between cycles.

setAsyncCycleHandler

OutputAdapter:setAsyncCycleHandler (proc: fun(backplane: Backplane)): fun(backplane: Backplane)

Sets the async cycle handler to pass to Backplane and returns it.

addComponentByPeripheralID

OutputAdapter:addComponentByPeripheralID (id: string)

This function calls peripheral.wrap(id) and appends the result to self.components with a key of id. If a peripheral was not found, an error is thrown.

addComponentByPeripheralType

OutputAdapter:addComponentByPeripheralType (type: string)

This function calls peripheral.find(type) and appends the result to self.components with a key of 'type_N', where type is the specified type and N is the current number of assigned components. Below is the result of calling this function multiple times.

-- in AlarmOutputAdapter.lua
function AlarmOutputAdapter:constructor ()
	self:addComponentByPeripheralType('minecraft:note_block')
	self:addComponentByPeripheralType('computercraft:speaker')
end

-- after initializing an AlarmOutputAdapter on a computer
-- next to a note block and a speaker, self.components might look like this
self.components = {
  ['minecraft:note_block_0'] = { --[[ note block peripheral ]] },
  ['computercraft:speaker_1'] = { --[[ speaker peripheral ]] },
}

write abstract

OutputAdapter:write (metrics: MetricCollection)

Writes provided MetricCollection to implementation-defined targets. This will be called by the Backplane during a cycle.

debug

OutputAdapter:debug (state: boolean)

Set internal debug state. When state is true, OutputAdapter will write verbose information to the terminal.

cacheable

OutputAdapter:cacheable ()

Flag this OutputAdapter implementation as cacheable. This will notify the Backplane to call getState() and loadState() on this adapter when needed.

getState abstract

OutputAdapter:getState (): table

Returns a serializable version of the OutputAdapter's internal state.

loadState abstract

OutputAdapter:loadState (state: table)

Loads a previously saved state into the OutputAdapter.