Trait Attribute

Source

pub trait Attribute: Sized {
    const DEFINDEX: u32;
    const ATTRIBUTE: AttributeDef;
    const USES_FLOAT_VALUE: bool;

    // Required method
    fn attribute_float_value(&self) -> Option<f32>;

    // Provided method
    fn attribute_value(&self) -> AttributeValue { ... }
}

Expand description

Attribute values for an item attribute.

Required Associated Constants§

Source

const USES_FLOAT_VALUE: bool

Not part of the schema.

This is a marker to specify which attribute field is meaningful to us in obtaining the attribute’s value.

§Kill Count Example

{
    "defindex": 214,
    "value": 918,
    "float_value": 1.28639199025018207e-42
}

This is the “kill_eater” attribute. “918” refers to the number of kills. The float_value field is the same number as a 32-bit float.

You can perform the conversions yourself with the following code:

let value = 918u32;
let float_value = 1.28639199025018207e-42f32;
 
assert_eq!(f32::from_bits(value), float_value);
assert_eq!(float_value.to_bits(), value);

§Sheen Example

{
    "defindex": 2014,
    "value": 1086324736,
    "float_value": 6
}

This is the “killstreak_idleeffect” attribute. “6” refers to the associated sheen ( Sheen::VillainousViolet), but is stored in the float_value field, unlike “kill_eater”. The value field is the same number as a 32-bit float.

While both values refer to the same value, and internally the attribute’s value is its float_value, there are many cases where the float_value doesn’t mean anything to us unless converted to a 32-bit integer from its bits, and if the float_value does mean something to us we don’t want to convert it to an integer. This can be a little confusing, but it’s just how the API is.

By marking each attribute with a uses_float_value flag, we can indicate whether the float_value field is meaningful to use for that attribute.

Required Methods§

Source

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

Gets the attribute float value.

Provided Methods§

Source

fn attribute_value(&self) -> AttributeValue

Gets the attribute value.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait Attribute Copy item path

Required Associated Constants§

const DEFINDEX: u32

const ATTRIBUTE: AttributeDef

const USES_FLOAT_VALUE: bool

§Kill Count Example

§Sheen Example

Required Methods§

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

Provided Methods§

fn attribute_value(&self) -> AttributeValue

Dyn Compatibility§

Implementors§

impl Attribute for FootprintsSpell

const DEFINDEX: u32 = 1_005u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for KillstreakTier

const DEFINDEX: u32 = 2_025u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for Killstreaker

const DEFINDEX: u32 = 2_013u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for Paint

const DEFINDEX: u32 = 142u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for PaintSpell

const DEFINDEX: u32 = 1_004u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for Sheen

const DEFINDEX: u32 = 2_014u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for Wear

const DEFINDEX: u32 = 725u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for CustomDescAttr

const DEFINDEX: u32 = 501u32

const USES_FLOAT_VALUE: bool = false

const ATTRIBUTE: AttributeDef

impl Attribute for CustomNameAttr

const DEFINDEX: u32 = 500u32

const USES_FLOAT_VALUE: bool = false

const ATTRIBUTE: AttributeDef

impl Attribute for CustomTextureHi

const DEFINDEX: u32 = 227u32

const USES_FLOAT_VALUE: bool = false

const ATTRIBUTE: AttributeDef

impl Attribute for CustomTextureLo

const DEFINDEX: u32 = 152u32

const USES_FLOAT_VALUE: bool = false

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem1

const DEFINDEX: u32 = 2_000u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem2

const DEFINDEX: u32 = 2_001u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem3

const DEFINDEX: u32 = 2_002u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem4

const DEFINDEX: u32 = 2_003u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem5

const DEFINDEX: u32 = 2_004u32

const USES_FLOAT_VALUE: bool = true

const ATTRIBUTE: AttributeDef

impl Attribute for DynamicRecipeComponentDefinedItem6

const DEFINDEX: u32 = 2_005u32

const USES_FLOAT_VALUE: bool = true

Trait Attribute