Struct BmdVegetation 

pub struct BmdVegetation { /* private fields */ }

Represents a BMD Vegetation file decoded in memory.

This struct contains all vegetation placement data for a battle map, including individual tree instances and grass coverage areas. Vegetation data is stored separately from the main BMD file to allow independent editing.

Fields

• serialise_version: File format version (currently only version 2)
• tree_list: List of individual tree placements
• grass_list: List of grass coverage areas

Version Support

• Version 2: Current format used in Warhammer III

Integration

Vegetation files work in conjunction with BMD files. The BMD file contains references to vegetation data via TreeListReferenceList and GrassListReferenceList, while this file contains the actual placement data.

Example

use rpfm_lib::files::bmd_vegetation::BmdVegetation;
use rpfm_lib::files::Decodeable;

let vegetation = BmdVegetation::decode(&mut reader, &None)?;

// Access tree data
for tree in vegetation.tree_list().list() {
    println!("Tree at ({}, {}, {})",
        tree.position().x(),
        tree.position().y(),
        tree.position().z()
    );
}

// Access grass data
for grass in vegetation.grass_list().list() {
    println!("Grass patch: {}", grass.grass_type());
}

Implementations

impl BmdVegetation

pub fn serialise_version(&self) -> &u16

File format version number (currently only version 2).

pub fn tree_list(&self) -> &TreeList

List of individual tree placements.

pub fn grass_list(&self) -> &GrassList

List of grass coverage areas.

impl BmdVegetation

pub fn serialise_version_mut(&mut self) -> &mut u16

File format version number (currently only version 2).

pub fn tree_list_mut(&mut self) -> &mut TreeList

List of individual tree placements.

pub fn grass_list_mut(&mut self) -> &mut GrassList

List of grass coverage areas.

impl BmdVegetation

pub fn set_serialise_version(&mut self, val: u16) -> &mut Self

File format version number (currently only version 2).

pub fn set_tree_list(&mut self, val: TreeList) -> &mut Self

List of individual tree placements.

pub fn set_grass_list(&mut self, val: GrassList) -> &mut Self

List of grass coverage areas.

Trait Implementations

impl Clone for BmdVegetation

fn clone(&self) -> BmdVegetation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BmdVegetation

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

Formats the value using the given formatter.

impl Decodeable for BmdVegetation

fn decode<R: ReadBytes>( data: &mut R, extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type.

impl Default for BmdVegetation

fn default() -> BmdVegetation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BmdVegetation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for BmdVegetation

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data.

impl PartialEq for BmdVegetation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToLayer for BmdVegetation

fn to_layer(&self, parent: &Bmd) -> Result<String>

Converts this data structure to Terry .layer XML entity definitions.

impl StructuralPartialEq for BmdVegetation