Factorio API Docs

1.1.56 <>

Class LuaCircuitNetwork

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

get_signal(signal)
int

help()
string

All methods and properties that this object supports.


[R]

The entity this circuit network reference is associated with


[R]

The wire type this network is associated with.


[R]

The circuit connector ID on the associated entity this network was gotten from.


:: array[Signal]
[R]

The circuit network signals last tick.


:: uint
[R]

The circuit networks ID.


:: uint
[R]

The number of circuits connected to this network.


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

get_signal(signal) → int

Parameters

signal

The signal to read.

Return values

:: int

The current value of the signal.


help() → string

All methods and properties that this object supports.

Return values

:: string

Attributes

entity :: LuaEntity [Read]

The entity this circuit network reference is associated with


wire_type :: defines.wire_type [Read]

The wire type this network is associated with.


circuit_connector_id :: defines.circuit_connector_id [Read]

The circuit connector ID on the associated entity this network was gotten from.


signals :: array[Signal] [Read]

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


network_id :: uint [Read]

The circuit networks ID.


connected_circuit_count :: uint [Read]

The number of circuits connected to this network.


valid :: boolean [Read]

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 :: string [Read]

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.

|<

Classes

Events

Concepts

Defines

Builtin types

>|