Struct Entity

pub struct Entity {
    pub key_values: IndexMap<String, String>,
    pub connections: Option<Vec<(String, String)>>,
    pub solids: Option<Vec<Solid>>,
    pub editor: Editor,
    pub is_hidden: bool,
}

Represents an entity in a VMF file.

Fields

key_values: IndexMap<String, String>

The key-value pairs associated with this entity.

connections: Option<Vec<(String, String)>>

The output connections of this entity.

solids: Option<Vec<Solid>>

The solids associated with this entity, if any.

editor: Editor

The editor data for this entity.

is_hidden: bool

Indicates if the entity is hidden within the editor. This field is primarily used when parsing a hidden block within a VMF file, and is not serialized back when writing the VMF.

Implementations

impl Entity

pub fn new(classname: impl Into<String>, id: u64) -> Self

Creates a new Entity with the specified classname and ID.

Arguments

• classname - The classname of the entity (e.g., “func_detail”, “info_player_start”).
• id - The unique ID of the entity.

Example

use vmf_forge::prelude::*;

let entity = Entity::new("info_player_start", 1);
assert_eq!(entity.classname(), Some("info_player_start"));
assert_eq!(entity.id(), 1);

pub fn set(&mut self, key: String, value: String)

Sets a key-value pair for the entity. If the key already exists, its value is updated.

Arguments

• key - The key to set.
• value - The value to set for the key.

pub fn remove_key(&mut self, key: &str) -> Option<String>

Removes a key-value pair from the entity, preserving the order of other keys.

Arguments

• key - The key to remove.

Returns

An Option containing the removed value, if the key was present.

pub fn swap_remove_key(&mut self, key: &str) -> Option<String>

Removes a key-value pair from the entity, potentially changing the order of other keys. This is faster than remove_key but does not preserve insertion order.

Arguments

• key - The key to remove.

Returns

An Option containing the removed value, if the key was present.

pub fn get(&self, key: &str) -> Option<&String>

Gets the value associated with the given key.

Arguments

• key - The key to get the value for.

Returns

An Option containing a reference to the value, if the key is present.

pub fn get_mut(&mut self, key: &str) -> Option<&mut String>

Gets a mutable reference to the value associated with the given key.

Arguments

• key - The key to get the value for.

Returns

An Option containing a mutable reference to the value, if the key is present.

pub fn classname(&self) -> Option<&str>

Returns the classname of the entity.

Returns

An Option containing the classname, if it exists.

pub fn targetname(&self) -> Option<&str>

Returns the targetname of the entity.

Returns

An Option containing the targetname, if it exists.

pub fn id(&self) -> u64

Returns the ID of the entity.

pub fn model(&self) -> Option<&str>

Returns the model of the entity.

Returns

An Option containing the model path, if it exists.

pub fn add_connection( &mut self, output: impl Into<String>, target_entity: impl AsRef<str>, input: impl AsRef<str>, parms: impl AsRef<str>, delay: f32, fire_limit: i32, )

Adds an output connection to the entity.

Arguments

• output - The name of the output on this entity.
• target_entity - The targetname of the entity to connect to.
• input - The name of the input on the target entity.
• parms - The parameters to pass to the input.
• delay - The delay before the input is triggered, in seconds.
• fire_limit - The number of times the output can be fired (-1 for unlimited).

Example

use vmf_forge::prelude::*;

let mut entity = Entity::new("logic_relay", 1);
entity.add_connection("OnTrigger", "my_door", "Open", "", 0.0, -1);

pub fn clear_connections(&mut self)

Removes all connections from this entity.

pub fn has_connection(&self, output: &str, input: &str) -> bool

Checks if a specific connection exists.

Arguments

• output The output to check
• input The input to check

Returns

• true if the connection exists, false otherwise.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Entity

Returns the “default value” for a type.

impl From<Entity> for VmfBlock

fn from(val: Entity) -> Self

Converts to this type from the input type.

impl PartialEq for Entity

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<VmfBlock> for Entity

type Error = VmfError

The type returned in the event of a conversion error.

fn try_from(block: VmfBlock) -> VmfResult<Self>

Performs the conversion.

impl VmfSerializable for Entity

fn to_vmf_string(&self, indent_level: usize) -> String

Serializes the object into a VMF string.

impl StructuralPartialEq for Entity