Struct BuildingUnitType

pub struct BuildingUnitType {

    pub construction_sprite: Option<SpriteID>,
    pub snow_sprite: Option<SpriteID>,
    pub connect_flag: u8,
    pub facet: i16,
    pub destroy_on_build: bool,
    pub on_build_make_unit: Option<UnitTypeID>,
    pub on_build_make_tile: Option<TerrainID>,
    pub on_build_make_overlay: i16,
    pub on_build_make_tech: Option<TechID>,
    pub can_burn: bool,
    pub linked_buildings: ArrayVec<[LinkedBuilding; 4]>,
    pub construction_unit: Option<UnitTypeID>,
    pub transform_unit: Option<UnitTypeID>,
    pub transform_sound: Option<SoundID>,
    pub construction_sound: Option<SoundID>,
    pub garrison_type: i8,
    pub garrison_heal_rate: f32,
    pub garrison_repair_rate: f32,
    pub salvage_unit: Option<UnitTypeID>,
    pub salvage_attributes: ArrayVec<[i8; 6]>,
    /* private fields */
}

Unit type class for buildings.

Fields

construction_sprite: Option<SpriteID>

Sprite to use during construction.

snow_sprite: Option<SpriteID>

Sprite to use when this building is finished and built on snow.

connect_flag: u8

TODO document

facet: i16

TODO document

destroy_on_build: bool

Whether the building should be immediately destroyed on completion.

on_build_make_unit: Option<UnitTypeID>

Unit to spawn at the build site on completion.

on_build_make_tile: Option<TerrainID>

Change the underlying terrain to this terrain ID on completion.

on_build_make_overlay: i16

TODO document

on_build_make_tech: Option<TechID>

Research this tech on completion.

can_burn: bool

Whether this building…can burn?

TODO document the details

linked_buildings: ArrayVec<[LinkedBuilding; 4]>

construction_unit: Option<UnitTypeID>

transform_unit: Option<UnitTypeID>

transform_sound: Option<SoundID>

construction_sound: Option<SoundID>

garrison_type: i8

garrison_heal_rate: f32

garrison_repair_rate: f32

salvage_unit: Option<UnitTypeID>

salvage_attributes: ArrayVec<[i8; 6]>

Implementations

impl BuildingUnitType

pub fn read_from(input: impl Read, version: f32) -> Result<Self>

Read this unit type from an input stream.

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write the unit type to an output stream.

Methods from Deref<Target = CombatUnitType>

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write this unit type to an output stream.

Methods from Deref<Target = BaseCombatUnitType>

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write this unit type to an output stream.

Methods from Deref<Target = ActionUnitType>

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write this unit type to an output stream.

Methods from Deref<Target = MovingUnitType>

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write this unit type to an output stream.

Methods from Deref<Target = AnimatedUnitType>

pub fn write_to(&self, output: impl Write, version: f32) -> Result<()>

Write this unit type to an output stream.

Methods from Deref<Target = BaseUnitType>

pub fn write_to(&self, output: impl Write, _version: f32) -> Result<()>

Write this unit type to an output stream.

Trait Implementations

impl Clone for BuildingUnitType

fn clone(&self) -> BuildingUnitType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildingUnitType

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

Formats the value using the given formatter.

impl Default for BuildingUnitType

fn default() -> BuildingUnitType

Returns the “default value” for a type.

impl Deref for BuildingUnitType

type Target = CombatUnitType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<BuildingUnitType> for UnitType

fn from(v: BuildingUnitType) -> Self

Converts to this type from the input type.