Skip to main content

Connection

Struct Connection 

Source
pub struct Connection {
    pub output: String,
    pub target: String,
    pub input: String,
    pub params: String,
    pub delay: f32,
    pub fire_limit: i32,
}
Expand description

Represents a connection between entities.

Fields§

§output: String§target: String§input: String§params: String§delay: f32§fire_limit: i32

Implementations§

Source§

impl Connection

Source

pub fn parse(output: String, value: &str) -> Self

Parses a connection string value.

§Arguments
  • output - The name of the output (e.g. “OnTrigger”).
  • value - The value string from VMF (e.g. “target,input,params,0.0,-1”).
Source

pub fn to_value_string(&self) -> String

Formats the connection value for VMF, always with the ESC separator.

Source

pub fn target_kind(&self) -> Target<'_>

Classifies how Connection::target addresses its destination.

Source

pub fn instance_input(&self) -> Option<InstanceIo<'_>>

Reads Connection::input as instance:<proxy>;<io>, if it is one.

Source

pub fn instance_output(&self) -> Option<InstanceIo<'_>>

Reads Connection::output as instance:<proxy>;<io>, if it is one.

Source

pub fn set_instance_input(&mut self, proxy: &str, io: &str)

Rewrites Connection::input to address an entity inside an instance.

Source

pub fn set_instance_output(&mut self, proxy: &str, io: &str)

Rewrites Connection::output to address an entity inside an instance.

Source

pub fn from_key_values(map: &IndexMap<String, String>) -> Option<Vec<Self>>

Deserializes a list of Connections from a connections block key-value map.

Source

pub fn to_key_values(connections: &[Self]) -> IndexMap<String, String>

Serializes a list of Connections into a connections block key-value map.

Trait Implementations§

Source§

impl Clone for Connection

Source§

fn clone(&self) -> Self

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 Debug for Connection

Source§

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

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

impl PartialEq for Connection

Source§

fn eq(&self, other: &Self) -> 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 Connection

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.