Skip to main content

LuaGenericOnOffControlBehavior

Struct LuaGenericOnOffControlBehavior 

Source
pub struct LuaGenericOnOffControlBehavior;
Expand description

An abstract base class for behaviors that support switching the entity on or off based on some condition.

Implementations§

Source§

impl LuaGenericOnOffControlBehavior

Source

pub fn entity(&self) -> LuaEntity

The entity this control behavior belongs to.

Source

pub fn input_networks(&self) -> CircuitNetworkSelection

Which circuit networks (red/green) to read signals from. Defaults to both wire colors.

nil if this control behavior does not allow selecting the input networks.

Source

pub fn output_networks(&self) -> CircuitNetworkSelection

Which circuit networks (red/green) to send signals to. Defaults to both wire colors.

nil if this control behavior does not allow selecting the output networks.

Source

pub fn type(&self) -> &str

The concrete type of this control behavior.

Source

pub fn circuit_condition(&self) -> CircuitConditionDefinition

The circuit condition. Writing nil clears the circuit condition.

Source

pub fn circuit_enable_disable(&self) -> bool

true if this entity enable/disable state is controlled by circuit condition

Source

pub fn connect_to_logistic_network(&self) -> bool

true if this should connect to the logistic network.

Source

pub fn disabled(&self) -> bool

If the entity is currently disabled because of the control behavior.

Source

pub fn logistic_condition(&self) -> CircuitConditionDefinition

The logistic condition. Writing nil clears the logistic condition.

Source

pub fn get_circuit_network( &self, wire_connector_id: &str, ) -> Option<LuaCircuitNetwork>

Trait Implementations§

Source§

impl Clone for LuaGenericOnOffControlBehavior

Source§

fn clone(&self) -> LuaGenericOnOffControlBehavior

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LuaGenericOnOffControlBehavior

Source§

impl Debug for LuaGenericOnOffControlBehavior

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LuaGenericOnOffControlBehavior

Source§

fn default() -> LuaGenericOnOffControlBehavior

Returns the “default value” for a type. Read more
Source§

impl Eq for LuaGenericOnOffControlBehavior

Source§

impl From<LuaGenericOnOffControlBehavior> for LuaAny

Source§

fn from(_: LuaGenericOnOffControlBehavior) -> Self

Converts to this type from the input type.
Source§

impl LuaObject for LuaGenericOnOffControlBehavior

Source§

impl PartialEq for LuaGenericOnOffControlBehavior

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LuaGenericOnOffControlBehavior

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.