Struct rust_sc2::bot::CountOptions

pub struct CountOptions<'a> {
    pub completion: Completion,
    pub alias: UnitAlias,
    // some fields omitted
}

Options used to configure which units are counted. Constructed with counter and enemy_counter methods.

Fields

completion: Completion

State of counted units. Can be:

• Complete - only complete units
• Ordered - only units in progress
• All - both compete and ordered units

[Default: Complete]

alias: UnitAlias

Alias of counted units. Can be:

• None - don’t count alias
• Unit - count unit-alias, used when unit has 2 forms
• Tech - count tech-alias, used when unit has more than 2 forms (usually structures)

[Default: None]

Implementations

impl<'a> CountOptions<'a>

pub fn ordered(&mut self) -> &mut Self

Sets completion to Ordered.

pub fn all(&mut self) -> &mut Self

Sets completion to All.

pub fn alias(&mut self) -> &mut Self

Sets alias to Unit.

pub fn tech(&mut self) -> &mut Self

Sets alias to Tech.

pub fn count(&self, unit_id: UnitTypeId) -> usize

Counts units of given type and returns the result.

Trait Implementations

impl<'a> Clone for CountOptions<'a>

fn clone(&self) -> CountOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CountOptions<'a>

impl Debug for CountOptions<'_>

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

Formats the value using the given formatter.