Enum Spell 

pub enum Spell {
    TeamSpiritFootprints,
    HeadlessHorseshoes,
    CorpseGrayFootprints,
    ViolentVioletFootprints,
    BruisedPurpleFootprints,
    GangreenFootprints,
    RottenOrangeFootprints,
    DieJob,
    ChromaticCorruption,
    PutrescentPigmentation,
    SpectralSpectrum,
    SinisterStaining,
    VoicesFromBelow,
    PumpkinBombs,
    HalloweenFire,
    Exorcism,
}

Spell.

As defined by the schema these wouldn’t normally be grouped together as different types of spells fall under different attributes, but in practice they are often treated as if they are.

Variants

TeamSpiritFootprints

HeadlessHorseshoes

CorpseGrayFootprints

ViolentVioletFootprints

BruisedPurpleFootprints

GangreenFootprints

RottenOrangeFootprints

DieJob

ChromaticCorruption

PutrescentPigmentation

SpectralSpectrum

SinisterStaining

VoicesFromBelow

PumpkinBombs

HalloweenFire

Exorcism

Implementations

impl Spell

pub const DEFINDEX_PAINT: u32 = 1_004u32

The attribute defindex for paint spells.

pub const DEFINDEX_FOOTPRINTS: u32 = 1_005u32

The attribute defindex for footprints spells.

pub const DEFINDEX_VOICES_FROM_BELOW: u32 = 1_006u32

The attribute defindex for voices from below spell.

pub const DEFINDEX_PUMPKIN_BOMBS: u32 = 1_007u32

The attribute defindex for pumpkin bombs spell.

pub const DEFINDEX_HALLOWEEN_FIRE: u32 = 1_008u32

The attribute defindex for halloween fire spell.

pub const DEFINDEX_EXORCISM: u32 = 1_009u32

The attribute defindex for exorcism spell.

pub fn attribute_defindex(&self) -> u32

Gets the attribute defindex of this spell.

pub fn attribute_id(&self) -> Option<u32>

Gets the attribute ID used to identify this spell. This will only return a value for footprints spells and paint spells.

pub fn is_paint_spell(&self) -> bool

Checks if this spell is a paint spell.

pub fn is_footprints_spell(&self) -> bool

Checks if this spell is a footprints spell.

Trait Implementations

impl Attributes for Spell

const ATTRIBUTES: &'static [AttributeDef]

Represents the “set_item_tint_rgb_override”, “halloween_footstep_type”, “halloween_voice_modulation”, “halloween_pumpkin_explosions”, “halloween_green_flames”, and “halloween_death_ghosts” attributes.

fn attribute_float_value(&self) -> Option<f32>

Gets the value of an attribute belonging to a group of spells.

Footprints and paint spells share a common attribute but have specific values that correspond to which spell is being referenced that can be used to identify the spell.

Examples

use tf2_enum::{Spell, Attributes};
 
assert_eq!(Spell::DieJob.attribute_float_value(), Some(0.));
assert_eq!(Spell::HeadlessHorseshoes.attribute_float_value(), Some(2.));
// 1 means true in this context
assert_eq!(Spell::Exorcism.attribute_float_value(), Some(1.));

const DEFINDEX: &'static [u32]

The list of associated defindexes.

const USES_FLOAT_VALUE: bool = true

See Attribute::USES_FLOAT_VALUE. This applies to all attributes in the set.

fn attribute_value(&self) -> AttributeValue

Gets the attribute value.

fn get_attribute_def_by_defindex(defindex: u32) -> Option<&'static AttributeDef>

Gets the attribute definition for a given defindex.

impl Clone for Spell

fn clone(&self) -> Spell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spell

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spell

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Spell

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

Formats the value using the given formatter.

impl EnumCount for Spell

const COUNT: usize = 16usize

impl From<&FootprintsSpell> for Spell

fn from(val: &FootprintsSpell) -> Self

Converts to this type from the input type.

impl From<&HalloweenDeathGhosts> for Spell

fn from(_: &HalloweenDeathGhosts) -> Self

Converts to this type from the input type.

impl From<&HalloweenGreenFlames> for Spell

fn from(_: &HalloweenGreenFlames) -> Self

Converts to this type from the input type.

impl From<&HalloweenPumpkinExplosions> for Spell

fn from(_: &HalloweenPumpkinExplosions) -> Self

Converts to this type from the input type.

impl From<&HalloweenVoiceModulation> for Spell

fn from(_: &HalloweenVoiceModulation) -> Self

Converts to this type from the input type.

impl From<&PaintSpell> for Spell

fn from(val: &PaintSpell) -> Self

Converts to this type from the input type.

impl From<FootprintsSpell> for Spell

fn from(val: FootprintsSpell) -> Self

Converts to this type from the input type.

impl From<HalloweenDeathGhosts> for Spell

fn from(_: HalloweenDeathGhosts) -> Self

Converts to this type from the input type.

impl From<HalloweenGreenFlames> for Spell

fn from(_: HalloweenGreenFlames) -> Self

Converts to this type from the input type.

impl From<HalloweenPumpkinExplosions> for Spell

fn from(_: HalloweenPumpkinExplosions) -> Self

Converts to this type from the input type.

impl From<HalloweenVoiceModulation> for Spell

fn from(_: HalloweenVoiceModulation) -> Self

Converts to this type from the input type.

impl From<PaintSpell> for Spell

fn from(val: PaintSpell) -> Self

Converts to this type from the input type.

impl From<Spell> for ItemAttribute

fn from(val: Spell) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a Spell> for SpellSet

fn from_iter<I: IntoIterator<Item = &'a Spell>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Spell> for SpellSet

fn from_iter<I: IntoIterator<Item = Spell>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for Spell

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Spell, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Spell

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for Spell

type Iterator = SpellIter

fn iter() -> SpellIter

impl Ord for Spell

fn cmp(&self, other: &Spell) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Spell

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

fn partial_cmp(&self, other: &Spell) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Spell

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Spell> for FootprintsSpell

type Error = TryFromSpellError

The type returned in the event of a conversion error.

fn try_from(value: &Spell) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Spell> for PaintSpell

type Error = TryFromSpellError

The type returned in the event of a conversion error.

fn try_from(value: &Spell) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Spell

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Spell, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Spell> for FootprintsSpell

type Error = TryFromSpellError

The type returned in the event of a conversion error.

fn try_from(value: Spell) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Spell> for PaintSpell

type Error = TryFromSpellError

The type returned in the event of a conversion error.

fn try_from(value: Spell) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Spell

impl Eq for Spell

impl StructuralPartialEq for Spell