Factorio Runtime Docs

Class LuaMiningDrillControlBehavior extends LuaGenericOnOffControlBehavior

Control behavior for mining drills.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

circuit_enable_disable [RW] :: boolean

true if this drill is enabled or disabled using the logistics or circuit condition.

true if this drill is enabled or disabled using the logistics or circuit condition.

circuit_read_resources [RW] :: boolean

true if this drill should send the resources in the field to the circuit network.

true if this drill should send the resources in the field to the circuit network.

resource_read_mode [RW] :: defines.control_behavior.mining_drill.resource_read_mode

If the mining drill should send just the resources in its area or the entire field it's on to the circuit network.

If the mining drill should send just the resources in its area or the entire field it's on to the circuit network.

resource_read_targets [R] :: array[LuaEntity]

The resource entities that the mining drill will send information about to the circuit network or an empty array.

The resource entities that the mining drill will send information about to the circuit network or an empty array.

valid [R] :: boolean

Is this object valid?

Is this object valid?

object_name [R] :: string

The class name of this object.

The class name of this object.

Inherited from LuaGenericOnOffControlBehavior: disabled, circuit_condition, logistic_condition, connect_to_logistic_network, valid, object_name, help
Inherited from LuaControlBehavior: type, entity, get_circuit_network

Methods

help()  → string

All methods and properties that this object supports.

Attributes

circuit_enable_disable :: boolean Read/Write

true if this drill is enabled or disabled using the logistics or circuit condition.


circuit_read_resources :: boolean Read/Write

true if this drill should send the resources in the field to the circuit network. Which resources depends on LuaMiningDrillControlBehavior::resource_read_mode


resource_read_mode :: defines.control_behavior.mining_drill.resource_read_mode Read/Write

If the mining drill should send just the resources in its area or the entire field it's on to the circuit network.


resource_read_targets :: array[LuaEntity] Read

The resource entities that the mining drill will send information about to the circuit network or an empty array.


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

>|