LuaCircuitNetwork

A circuit network associated with a given entity, connector, and wire type.

Attributes

entity

• Read: LuaEntity
• Write: unknown
• Optional: false

The entity this circuit network reference is associated with.

wire_type

• Read: defines.wire_type
• Write: unknown
• Optional: false

The wire type this network is associated with.

wire_connector_id

• Read: defines.wire_connector_id
• Write: unknown
• Optional: false

Wire connector ID on associated entity this network was gotten from.

signals

• Read: Array<Signal>
• Write: unknown
• Optional: true

The circuit network signals last tick. nil if there were no signals last tick.

network_id

• Read: uint32
• Write: unknown
• Optional: false

The circuit networks ID.

connected_circuit_count

• Read: uint32
• Write: unknown
• Optional: false

The number of circuits connected to this network.

valid

• Read: boolean
• Write: unknown
• Optional: false

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Methods

get_signal

LuaCircuitNetwork.get_signal(signal: SignalID) -> int32

Call As

circuitNetwork.get_signal(signal)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• signal: SignalID — The signal to read.

Returns

• int32 — The current value of the signal.