Struct CombatUnitType

pub struct CombatUnitType {

    pub costs: ArrayVec<[AttributeCost; 3]>,
    pub create_time: u16,
    pub create_at_building: Option<UnitTypeID>,
    pub create_button: i8,
    pub rear_attack_modifier: f32,
    pub flank_attack_modifier: f32,
    pub hero_flag: u8,
    pub garrison_sprite: Option<SpriteID>,
    pub volley_fire_amount: f32,
    pub max_attacks_in_volley: i8,
    pub volley_spread: (f32, f32),
    pub volley_start_spread_adjustment: f32,
    pub volley_missile: Option<UnitTypeID>,
    pub special_attack_sprite: Option<SpriteID>,
    pub special_attack_flag: i8,
    pub displayed_pierce_armor: i16,
    /* private fields */
}

Fields

costs: ArrayVec<[AttributeCost; 3]>

The costs of creating a unit of this type.

create_time: u16

create_at_building: Option<UnitTypeID>

Unit type ID of the building or unit where this unit can be created.

create_button: i8

Button location index where the button to create this unit should be shown when a create_at_building unit is selected.

rear_attack_modifier: f32

flank_attack_modifier: f32

hero_flag: u8

Is this unit a hero unit?

TODO what is special about hero units? Does it just opt into the healing behaviour?

garrison_sprite: Option<SpriteID>

volley_fire_amount: f32

max_attacks_in_volley: i8

volley_spread: (f32, f32)

volley_start_spread_adjustment: f32

volley_missile: Option<UnitTypeID>

special_attack_sprite: Option<SpriteID>

special_attack_flag: i8

displayed_pierce_armor: i16

Implementations

impl CombatUnitType

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 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 CombatUnitType

fn clone(&self) -> CombatUnitType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CombatUnitType

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

Formats the value using the given formatter.

impl Default for CombatUnitType

fn default() -> CombatUnitType

Returns the “default value” for a type.

impl Deref for CombatUnitType

type Target = BaseCombatUnitType

The resulting type after dereferencing.

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

Dereferences the value.

impl From<CombatUnitType> for UnitType

fn from(v: CombatUnitType) -> Self

Converts to this type from the input type.