Struct LuaCircuitNetwork 

pub struct LuaCircuitNetwork;

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

Implementations

impl LuaCircuitNetwork

pub fn connected_circuit_count(&self) -> u32

The number of circuits connected to this network.

pub fn entity(&self) -> LuaEntity

The entity this circuit network reference is associated with.

pub fn network_id(&self) -> u32

The circuit networks ID.

pub fn object_name(&self) -> &str

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.

pub fn signals(&self) -> Vec<Signal>

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

pub fn valid(&self) -> bool

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.

pub fn wire_connector_id(&self) -> &str

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

pub fn wire_type(&self) -> &str

The wire type this network is associated with.

pub fn get_signal(&self, signal: SignalID) -> i32

Trait Implementations

impl Clone for LuaCircuitNetwork

fn clone(&self) -> LuaCircuitNetwork

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaCircuitNetwork

impl Debug for LuaCircuitNetwork

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaCircuitNetwork

fn default() -> LuaCircuitNetwork

Returns the “default value” for a type.

impl Eq for LuaCircuitNetwork

impl From<LuaCircuitNetwork> for LuaAny

fn from(_: LuaCircuitNetwork) -> Self

Converts to this type from the input type.

impl LuaObject for LuaCircuitNetwork

impl PartialEq for LuaCircuitNetwork

fn eq(&self, other: &LuaCircuitNetwork) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaCircuitNetwork