Struct sc2::data::AbilityData

pub struct AbilityData { /* fields omitted */ }

data about an ability

Methods

impl AbilityData

pub fn get_generalized_ability(&self) -> Ability

get the most generalized id of the ability

pub fn is_available(&self) -> bool

indicates whether the ability is available to the current mods/map

pub fn get_id(&self) -> Ability

stable ID for the ability

pub fn get_link_name(&self) -> &str

catalog (game data xml) name of the ability

pub fn get_link_index(&self) -> u32

catalog (game data xml) index of the ability

pub fn get_button_name(&self) -> &str

name of the button for the command card

pub fn get_friendly_name(&self) -> &str

in case the button name is not descriptive

pub fn get_hotkey(&self) -> &str

UI hotkey

pub fn get_remap_abilities(&self) -> &[Ability]

other abilities that can remap to this generic ability

pub fn get_target(&self) -> Option<AbilityTarget>

type of target that this ability uses

pub fn casts_in_minimap(&self) -> bool

can be cast in the minimap (unimplemented)

pub fn can_autocast(&self) -> bool

autocast can be set

pub fn is_building(&self) -> bool

requires placement to construct a building

pub fn get_footprint_radius(&self) -> Option<f32>

if the ability is placing a building, give the radius of the footprint

pub fn is_instant_placement(&self) -> bool

placement next to an existing structure (an addon like a Tech Lab)

pub fn get_cast_range(&self) -> f32

range unit can cast ability without needing to approach target

Trait Implementations

impl Debug for AbilityData

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for AbilityData

fn clone(&self) -> AbilityData

Returns a copy of the value.

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

Performs copy-assignment from source.