Struct Bmd 

pub struct Bmd { /* private fields */ }

Represents a complete Battle Map Definition file decoded in memory.

This struct contains all battle map data including buildings, terrain, lighting, deployment zones, AI hints, and numerous other gameplay and visual elements.

Field Categories

Core

• serialise_version: File format version (23-27)

Buildings & Objects

• battlefield_building_list - Buildings inside the battlefield area
• battlefield_building_list_far - Buildings outside the battlefield area
• prefab_instance_list: Prefab object instances
• prop_list: Small decorative props
• composite_scene_list: Composite scene references

Terrain & Boundaries

• terrain_outlines: Terrain area boundaries
• non_terrain_outlines: Non-terrain area boundaries
• go_outlines: Traversable area outlines (where units can go).
• water_outlines: Water body boundaries
• bmd_outline_list: Additional outline definitions
• lite_building_outlines: Simplified building outlines
• playable_area: Playable map boundaries

Gameplay

• deployment_list: Unit deployment zones
• capture_location_set: Capture point locations
• bmd_catchment_area_list: Catchment area definitions
• zones_template_list: Zone template definitions
• ef_line_list: Entity Formation line definitions
• ai_hints: AI pathfinding and behavior hints

Lighting

• point_light_list: Point light sources
• spot_light_list: Spotlight sources
• light_probe_list: Global illumination probes

Effects & Audio

• particle_emitter_list: Particle effect emitters
• sound_shape_list: 3D audio zones
• building_projectile_emitter_list: Building-based projectile emitters

Vegetation

• tree_list_reference_list: Tree placement references
• grass_list_reference_list: Grass placement references

Advanced Rendering

• custom_material_mesh_list: Custom material meshes
• terrain_stencil_triangle_list: Terrain stencil geometry
• terrain_stencil_blend_triangle_list: Blended stencil geometry
• terrain_decal_list: Terrain decal placements

Civilians & Sieges

• civilian_deployment_list: Civilian unit spawns
• civilian_shelter_list: Civilian shelter locations
• toggleable_buildings_slot_list: Destructible building slots

Cameras

• camera_zones: Camera constraint volumes

Getset

All fields have public getters, mutable getters, and setters generated via getset:

let version = bmd.serialise_version();  // Getter
*bmd.serialise_version_mut() = 27;      // Mutable getter
bmd.set_serialise_version(27);          // Setter

Example

use rpfm_lib::files::bmd::Bmd;
use rpfm_lib::files::Decodeable;

let bmd = Bmd::decode(&mut reader, &None)?;

// Check version
println!("BMD version: {}", bmd.serialise_version());

// Iterate buildings
for building in bmd.battlefield_building_list().list() {
    println!("Building key: {:?}", building.key());
}

// Access deployment zones
for zone in bmd.deployment_list().list() {
    println!("Deployment zone: {:?}", zone);
}

Implementations

impl Bmd

pub fn serialise_version(&self) -> &u16

File format version number (23-27).

pub fn battlefield_building_list(&self) -> &BattlefieldBuildingList

Building instances inside the battlefield area.

pub fn battlefield_building_list_far(&self) -> &BattlefieldBuildingListFar

Building instances outside the battlefield area.

pub fn capture_location_set(&self) -> &CaptureLocationSet

Groups of capture locations.

pub fn ef_line_list(&self) -> &EFLineList

Entity Formation line definitions.

pub fn go_outlines(&self) -> &GoOutlines

Traversable area outlines (where units can go).

pub fn non_terrain_outlines(&self) -> &NonTerrainOutlines

Non-terrain area boundary outlines.

pub fn zones_template_list(&self) -> &ZonesTemplateList

Zone template definitions.

pub fn prefab_instance_list(&self) -> &PrefabInstanceList

Prefab object instances.

pub fn bmd_outline_list(&self) -> &BmdOutlineList

Additional outline definitions.

pub fn terrain_outlines(&self) -> &TerrainOutlines

Terrain area boundary outlines.

pub fn lite_building_outlines(&self) -> &LiteBuildingOutlines

Simplified building outline definitions.

pub fn camera_zones(&self) -> &CameraZones

Camera constraint volumes.

pub fn civilian_deployment_list(&self) -> &CivilianDeploymentList

Civilian unit deployment locations.

pub fn civilian_shelter_list(&self) -> &CivilianShelterList

Civilian shelter locations.

pub fn prop_list(&self) -> &PropList

Small decorative prop instances.

pub fn particle_emitter_list(&self) -> &ParticleEmitterList

Particle effect emitter instances.

pub fn ai_hints(&self) -> &AIHints

AI pathfinding and behavior hints.

pub fn light_probe_list(&self) -> &LightProbeList

Global illumination light probes.

pub fn terrain_stencil_triangle_list(&self) -> &TerrainStencilTriangleList

Terrain stencil triangle geometry.

pub fn point_light_list(&self) -> &PointLightList

Point light source instances.

pub fn building_projectile_emitter_list(&self) -> &BuildingProjectileEmitterList

Building-based projectile emitter instances.

pub fn playable_area(&self) -> &PlayableArea

Playable map area boundaries.

pub fn custom_material_mesh_list(&self) -> &CustomMaterialMeshList

Custom material mesh instances.

pub fn terrain_stencil_blend_triangle_list( &self, ) -> &TerrainStencilBlendTriangleList

Blended terrain stencil triangle geometry.

pub fn spot_light_list(&self) -> &SpotLightList

Spotlight source instances.

pub fn sound_shape_list(&self) -> &SoundShapeList

3D audio zone definitions.

pub fn composite_scene_list(&self) -> &CompositeSceneList

Composite scene references.

pub fn deployment_list(&self) -> &DeploymentList

Unit deployment zone definitions.

pub fn bmd_catchment_area_list(&self) -> &BmdCatchmentAreaList

Catchment area definitions.

pub fn toggleable_buildings_slot_list(&self) -> &ToggleableBuildingsSlotList

Destructible/toggleable building slot definitions.

pub fn terrain_decal_list(&self) -> &TerrainDecalList

Terrain decal placements.

pub fn tree_list_reference_list(&self) -> &TreeListReferenceList

Tree placement references (links to vegetation files).

pub fn grass_list_reference_list(&self) -> &GrassListReferenceList

Grass placement references (links to vegetation files).

pub fn water_outlines(&self) -> &WaterOutlines

Water body boundary outlines.

impl Bmd

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

File format version number (23-27).

pub fn battlefield_building_list_mut(&mut self) -> &mut BattlefieldBuildingList

Building instances inside the battlefield area.

pub fn battlefield_building_list_far_mut( &mut self, ) -> &mut BattlefieldBuildingListFar

Building instances outside the battlefield area.

pub fn capture_location_set_mut(&mut self) -> &mut CaptureLocationSet

Groups of capture locations.

pub fn ef_line_list_mut(&mut self) -> &mut EFLineList

Entity Formation line definitions.

pub fn go_outlines_mut(&mut self) -> &mut GoOutlines

Traversable area outlines (where units can go).

pub fn non_terrain_outlines_mut(&mut self) -> &mut NonTerrainOutlines

Non-terrain area boundary outlines.

pub fn zones_template_list_mut(&mut self) -> &mut ZonesTemplateList

Zone template definitions.

pub fn prefab_instance_list_mut(&mut self) -> &mut PrefabInstanceList

Prefab object instances.

pub fn bmd_outline_list_mut(&mut self) -> &mut BmdOutlineList

Additional outline definitions.

pub fn terrain_outlines_mut(&mut self) -> &mut TerrainOutlines

Terrain area boundary outlines.

pub fn lite_building_outlines_mut(&mut self) -> &mut LiteBuildingOutlines

Simplified building outline definitions.

pub fn camera_zones_mut(&mut self) -> &mut CameraZones

Camera constraint volumes.

pub fn civilian_deployment_list_mut(&mut self) -> &mut CivilianDeploymentList

Civilian unit deployment locations.

pub fn civilian_shelter_list_mut(&mut self) -> &mut CivilianShelterList

Civilian shelter locations.

pub fn prop_list_mut(&mut self) -> &mut PropList

Small decorative prop instances.

pub fn particle_emitter_list_mut(&mut self) -> &mut ParticleEmitterList

Particle effect emitter instances.

pub fn ai_hints_mut(&mut self) -> &mut AIHints

AI pathfinding and behavior hints.

pub fn light_probe_list_mut(&mut self) -> &mut LightProbeList

Global illumination light probes.

pub fn terrain_stencil_triangle_list_mut( &mut self, ) -> &mut TerrainStencilTriangleList

Terrain stencil triangle geometry.

pub fn point_light_list_mut(&mut self) -> &mut PointLightList

Point light source instances.

pub fn building_projectile_emitter_list_mut( &mut self, ) -> &mut BuildingProjectileEmitterList

Building-based projectile emitter instances.

pub fn playable_area_mut(&mut self) -> &mut PlayableArea

Playable map area boundaries.

pub fn custom_material_mesh_list_mut(&mut self) -> &mut CustomMaterialMeshList

Custom material mesh instances.

pub fn terrain_stencil_blend_triangle_list_mut( &mut self, ) -> &mut TerrainStencilBlendTriangleList

Blended terrain stencil triangle geometry.

pub fn spot_light_list_mut(&mut self) -> &mut SpotLightList

Spotlight source instances.

pub fn sound_shape_list_mut(&mut self) -> &mut SoundShapeList

3D audio zone definitions.

pub fn composite_scene_list_mut(&mut self) -> &mut CompositeSceneList

Composite scene references.

pub fn deployment_list_mut(&mut self) -> &mut DeploymentList

Unit deployment zone definitions.

pub fn bmd_catchment_area_list_mut(&mut self) -> &mut BmdCatchmentAreaList

Catchment area definitions.

pub fn toggleable_buildings_slot_list_mut( &mut self, ) -> &mut ToggleableBuildingsSlotList

Destructible/toggleable building slot definitions.

pub fn terrain_decal_list_mut(&mut self) -> &mut TerrainDecalList

Terrain decal placements.

pub fn tree_list_reference_list_mut(&mut self) -> &mut TreeListReferenceList

Tree placement references (links to vegetation files).

pub fn grass_list_reference_list_mut(&mut self) -> &mut GrassListReferenceList

Grass placement references (links to vegetation files).

pub fn water_outlines_mut(&mut self) -> &mut WaterOutlines

Water body boundary outlines.

impl Bmd

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

File format version number (23-27).

pub fn set_battlefield_building_list( &mut self, val: BattlefieldBuildingList, ) -> &mut Self

Building instances inside the battlefield area.

pub fn set_battlefield_building_list_far( &mut self, val: BattlefieldBuildingListFar, ) -> &mut Self

Building instances outside the battlefield area.

pub fn set_capture_location_set(&mut self, val: CaptureLocationSet) -> &mut Self

Groups of capture locations.

pub fn set_ef_line_list(&mut self, val: EFLineList) -> &mut Self

Entity Formation line definitions.

pub fn set_go_outlines(&mut self, val: GoOutlines) -> &mut Self

Traversable area outlines (where units can go).

pub fn set_non_terrain_outlines(&mut self, val: NonTerrainOutlines) -> &mut Self

Non-terrain area boundary outlines.

pub fn set_zones_template_list(&mut self, val: ZonesTemplateList) -> &mut Self

Zone template definitions.

pub fn set_prefab_instance_list(&mut self, val: PrefabInstanceList) -> &mut Self

Prefab object instances.

pub fn set_bmd_outline_list(&mut self, val: BmdOutlineList) -> &mut Self

Additional outline definitions.

pub fn set_terrain_outlines(&mut self, val: TerrainOutlines) -> &mut Self

Terrain area boundary outlines.

pub fn set_lite_building_outlines( &mut self, val: LiteBuildingOutlines, ) -> &mut Self

Simplified building outline definitions.

pub fn set_camera_zones(&mut self, val: CameraZones) -> &mut Self

Camera constraint volumes.

pub fn set_civilian_deployment_list( &mut self, val: CivilianDeploymentList, ) -> &mut Self

Civilian unit deployment locations.

pub fn set_civilian_shelter_list( &mut self, val: CivilianShelterList, ) -> &mut Self

Civilian shelter locations.

pub fn set_prop_list(&mut self, val: PropList) -> &mut Self

Small decorative prop instances.

pub fn set_particle_emitter_list( &mut self, val: ParticleEmitterList, ) -> &mut Self

Particle effect emitter instances.

pub fn set_ai_hints(&mut self, val: AIHints) -> &mut Self

AI pathfinding and behavior hints.

pub fn set_light_probe_list(&mut self, val: LightProbeList) -> &mut Self

Global illumination light probes.

pub fn set_terrain_stencil_triangle_list( &mut self, val: TerrainStencilTriangleList, ) -> &mut Self

Terrain stencil triangle geometry.

pub fn set_point_light_list(&mut self, val: PointLightList) -> &mut Self

Point light source instances.

pub fn set_building_projectile_emitter_list( &mut self, val: BuildingProjectileEmitterList, ) -> &mut Self

Building-based projectile emitter instances.

pub fn set_playable_area(&mut self, val: PlayableArea) -> &mut Self

Playable map area boundaries.

pub fn set_custom_material_mesh_list( &mut self, val: CustomMaterialMeshList, ) -> &mut Self

Custom material mesh instances.

pub fn set_terrain_stencil_blend_triangle_list( &mut self, val: TerrainStencilBlendTriangleList, ) -> &mut Self

Blended terrain stencil triangle geometry.

pub fn set_spot_light_list(&mut self, val: SpotLightList) -> &mut Self

Spotlight source instances.

pub fn set_sound_shape_list(&mut self, val: SoundShapeList) -> &mut Self

3D audio zone definitions.

pub fn set_composite_scene_list(&mut self, val: CompositeSceneList) -> &mut Self

Composite scene references.

pub fn set_deployment_list(&mut self, val: DeploymentList) -> &mut Self

Unit deployment zone definitions.

pub fn set_bmd_catchment_area_list( &mut self, val: BmdCatchmentAreaList, ) -> &mut Self

Catchment area definitions.

pub fn set_toggleable_buildings_slot_list( &mut self, val: ToggleableBuildingsSlotList, ) -> &mut Self

Destructible/toggleable building slot definitions.

pub fn set_terrain_decal_list(&mut self, val: TerrainDecalList) -> &mut Self

Terrain decal placements.

pub fn set_tree_list_reference_list( &mut self, val: TreeListReferenceList, ) -> &mut Self

Tree placement references (links to vegetation files).

pub fn set_grass_list_reference_list( &mut self, val: GrassListReferenceList, ) -> &mut Self

Grass placement references (links to vegetation files).

pub fn set_water_outlines(&mut self, val: WaterOutlines) -> &mut Self

Water body boundary outlines.

impl Bmd

pub fn export_prefab_to_raw_data( &self, name: &str, vegetation: Option<&BmdVegetation>, output_path: &Path, ) -> Result<()>

Exports this BMD to Terry (Creative Assembly’s editor) format.

Generates two files for use in Terry:

• .terry - Project file defining the prefab structure
• .layer - Scene layer with entities, associations, and vegetation

Parameters

• name: Base name for output files (e.g., “siege_map”)
• vegetation: Optional vegetation data from BMD vegetation file
• output_path: Directory where files will be created

Returns

• Ok(()): Successfully exported files
• Err(_): I/O error or conversion error

Generated Files

• {name}.terry - Project file with scene hierarchy
• {name}.187abf10b8b9a13.layer - Layer file with entities

Entity Associations

The layer file includes two association types:

• Logical: Parent-child grouping relationships in Terry’s UI
• Transform: Spatial/hierarchical relationships

Example

use rpfm_lib::files::bmd::Bmd;
use rpfm_lib::files::bmd_vegetation::BmdVegetation;
use std::path::Path;

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

bmd.export_prefab_to_raw_data(
    "my_battle_map",
    Some(&vegetation),
    Path::new("output/")
)?;

Note

Not all BMD data lists are currently exported. Some are commented out in the implementation and will be added as export support is completed.

pub fn logical_associations(&self) -> HashMap<String, Vec<String>>

Returns logical entity associations for Terry export.

Logical associations define parent-child grouping relationships for organizing entities in Terry’s UI hierarchy.

Returns

Map of parent entity IDs to their logically grouped child entity IDs.

Note

Currently returns an empty map. Will be populated as association logic is implemented.

pub fn trasnform_associations(&self) -> HashMap<String, Vec<String>>

Returns transform (spatial hierarchy) entity associations for Terry export.

Transform associations define parent-child spatial relationships between entities (e.g., props attached to buildings, lights attached to structures).

Returns

Map of parent entity IDs to their child entity IDs.

Note

Currently returns an empty map. Will be populated as association logic is implemented.

Trait Implementations

impl Clone for Bmd

fn clone(&self) -> Bmd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bmd

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

Formats the value using the given formatter.

impl Decodeable for Bmd

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

Decodes binary data into the implementing type.

impl Default for Bmd

fn default() -> Bmd

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bmd

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for Bmd

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

Encodes the implementing type into binary data.

impl PartialEq for Bmd

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Bmd