Struct VmfFile

pub struct VmfFile {
    pub path: Option<String>,
    pub versioninfo: VersionInfo,
    pub visgroups: VisGroups,
    pub viewsettings: ViewSettings,
    pub world: World,
    pub entities: Entities,
    pub hiddens: Entities,
    pub cameras: Cameras,
    pub cordons: Cordons,
}

Represents a parsed VMF file.

Fields

path: Option<String>

The path to the VMF file, if known.

versioninfo: VersionInfo

The version info of the VMF file.

visgroups: VisGroups

The visgroups in the VMF file.

viewsettings: ViewSettings

The view settings in the VMF file.

world: World

The world data in the VMF file.

entities: Entities

The entities in the VMF file.

hiddens: Entities

The hidden entities in the VMF file.

cameras: Cameras

The camera data in the VMF file.

cordons: Cordons

The cordon data in the VMF file.

Implementations

impl VmfFile

pub fn parse(content: &str) -> VmfResult<Self>

Parses a VMF file from a string.

Arguments

• content - The string content of the VMF file.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if parsing fails.

Examples

use vmf_forge::VmfFile;

let vmf_content = r#"
versioninfo
{
    "editorversion" "400"
    "editorbuild" "8000"
    "mapversion" "1"
    "formatversion" "100"
    "prefab" "0"
}
"#;

let vmf_file = VmfFile::parse(vmf_content);
assert!(vmf_file.is_ok());

pub fn parse_file(file: &mut impl Read) -> VmfResult<Self>

Parses a VMF file from a File.

Arguments

• file - The File to read from.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if parsing fails.

Examples

use vmf_forge::VmfFile;
use std::fs::File;

let mut file = File::open("your_map.vmf").unwrap();
let vmf_file = VmfFile::parse_file(&mut file);
assert!(vmf_file.is_ok());

pub fn open(path: impl AsRef<Path>) -> VmfResult<Self>

Opens and parses a VMF file from a file path.

Arguments

• path - The path to the VMF file.

Returns

A VmfResult containing the parsed VmfFile or a VmfError if an error occurs.

Examples

use vmf_forge::VmfFile;

let vmf_file = VmfFile::open("your_map.vmf");
assert!(vmf_file.is_ok());

pub fn save(&self, path: impl AsRef<Path>) -> VmfResult<()>

Saves the VmfFile to a file at the specified path.

Arguments

• path - The path to save the VMF file to.

Returns

A VmfResult indicating success or a VmfError if an error occurs.

Examples

use vmf_forge::VmfFile;

let vmf_file = VmfFile::open("your_map.vmf").unwrap();
let result = vmf_file.save("new_map.vmf");
assert!(result.is_ok());

impl VmfFile

pub fn merge(&mut self, other: VmfFile)

Merges the contents of another VmfFile into this one.

This method combines the visgroups, world solids (both visible and hidden), entities, hiddens, and cordons from the other VmfFile into the current VmfFile. versioninfo, viewsettings, and cameras are not merged; the original values in self are retained.

This method is experimental and its behavior may change in future versions. It does not handle potential ID conflicts between the two VMF files.

Arguments

• other - The VmfFile to merge into this one.

Example

use vmf_forge::prelude::*;

let mut vmf1 = VmfFile::open("map1.vmf").unwrap();
let vmf2 = VmfFile::open("map2.vmf").unwrap();

vmf1.merge(vmf2);

// vmf1 now contains the combined contents of both files.

impl VmfFile

pub fn get_entities_in_visgroup( &self, group_id: i32, include_children: bool, ) -> Option<impl Iterator<Item = &Entity> + '_>

Returns an iterator over entities (including hidden ones) belonging to the specified VisGroup ID.

Arguments

• group_id - The ID of the target VisGroup.
• include_children - If true, includes entities from all child VisGroups recursively.

Returns

An Option containing an iterator yielding references to the matching Entity objects. Returns None if no VisGroup with the given group_id is found.

pub fn get_entities_in_visgroup_mut( &mut self, group_id: i32, include_children: bool, ) -> Option<impl Iterator<Item = &mut Entity> + '_>

Returns a mutable iterator over entities (including hidden ones) belonging to the specified VisGroup ID.

Arguments

• group_id - The ID of the target VisGroup.
• include_children - If true, includes entities from all child VisGroups recursively.

Returns

An Option containing an iterator yielding mutable references to the matching Entity objects. Returns None if no VisGroup with the given group_id is found.

pub fn get_solids_in_visgroup( &self, group_id: i32, include_children: bool, ) -> Option<impl Iterator<Item = &Solid> + '_>

Returns an iterator over world solids (visible and hidden) belonging to the specified VisGroup ID.

Arguments

• group_id - The ID of the target VisGroup.
• include_children - If true, includes solids from all child VisGroups recursively.

Returns

An Option containing an iterator yielding references to the matching Solid objects. Returns None if no VisGroup with the given group_id is found.

pub fn get_solids_in_visgroup_mut( &mut self, group_id: i32, include_children: bool, ) -> Option<impl Iterator<Item = &mut Solid> + '_>

Returns a mutable iterator over world solids (visible and hidden) belonging to the specified VisGroup ID.

Arguments

• group_id - The ID of the target VisGroup.
• include_children - If true, includes solids from all child VisGroups recursively.

Returns

An Option containing an iterator yielding mutable references to the matching Solid objects. Returns None if no VisGroup with the given group_id is found.

impl VmfFile

pub fn to_vmf_string(&self) -> String

Converts the VmfFile to a string in VMF format.

Returns

A string representing the VmfFile in VMF format.

Trait Implementations

impl Clone for VmfFile

fn clone(&self) -> VmfFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VmfFile

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

Formats the value using the given formatter.

impl Default for VmfFile

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for VmfFile

type Err = VmfError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for VmfFile

fn eq(&self, other: &VmfFile) -> 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 StructuralPartialEq for VmfFile