Type Definition eos_rs::api::items::ExclusiveItemEffectId

source ·
pub type ExclusiveItemEffectId = exclusive_item_effect_id;
Expand description

An exclusive item effect ID with associated methods to get metadata.

Use the associated constants or the Self::new method to get instances of this.

Implementations§

source§

impl ExclusiveItemEffectId

This impl provides general metadata about exclusive item effects in the game.

source

pub const unsafe fn new(id: u32) -> Self

Returns the ID struct for the exclusive item effect with the given ID.

Safety

The caller must make sure the ID is valid (refers to an existing exclusive item effect), otherwise this is UB.

source

pub const fn id(&self) -> u32

Returns the ID of this exclusive item effect.

source

pub fn set_exclusive_item_effect(&self, effect_flags: &mut u32)

Sets the bit for an exclusive item effect.

source

pub fn test_exclusive_item_effect_flag(&self, effect_flags: &mut u32) -> bool

Tests the exclusive item bitvector for a specific exclusive item effect.

Trait Implementations§