Struct StateFlags 

pub struct StateFlags(pub u32);

State flags bitmask helper for inventory items.

Items in Borderlands 4 saves have a state_flags field that encodes various properties using a bitmask. This struct provides a type-safe way to work with these flags without knowing the bit positions.

Example

use bl4::StateFlags;

// Create flags for a backpack item marked as favorite
let flags = StateFlags::backpack().with_favorite();

// Create flags for an equipped item
let equipped = StateFlags::equipped();

// Query flags
assert!(flags.is_favorite());
assert!(flags.is_in_backpack());

Tuple Fields

0: u32

Implementations

impl StateFlags

pub fn backpack() -> Self

Create flags for a backpack item (valid + in_backpack).

pub fn equipped() -> Self

Create flags for an equipped item (valid only, no backpack bit).

pub fn bank() -> Self

Create flags for a bank item (valid only).

pub fn from_raw(bits: u32) -> Self

Create flags from a raw u32 value.

pub fn to_raw(self) -> u32

Get the raw u32 value.

pub fn with_favorite(self) -> Self

Set the favorite label (clears other labels).

pub fn with_junk(self) -> Self

Set the junk label (clears other labels).

pub fn with_label1(self) -> Self

Set label 1 (clears other labels).

pub fn with_label2(self) -> Self

Set label 2 (clears other labels).

pub fn with_label3(self) -> Self

Set label 3 (clears other labels).

pub fn with_label4(self) -> Self

Set label 4 (clears other labels).

pub fn with_no_label(self) -> Self

Clear all labels (favorite, junk, 1-4).

pub fn is_favorite(&self) -> bool

Check if the favorite flag is set.

pub fn is_junk(&self) -> bool

Check if the junk flag is set.

pub fn has_label1(&self) -> bool

Check if label 1 is set.

pub fn has_label2(&self) -> bool

Check if label 2 is set.

pub fn has_label3(&self) -> bool

Check if label 3 is set.

pub fn has_label4(&self) -> bool

Check if label 4 is set.

pub fn is_in_backpack(&self) -> bool

Check if the item is in backpack (not equipped).

pub fn is_equipped(&self) -> bool

Check if the item is equipped (not in backpack only).

pub fn set_favorite(&mut self, value: bool)

Set favorite label (clears other labels) or clear it.

pub fn set_junk(&mut self, value: bool)

Set junk label (clears other labels) or clear it.

pub fn set_label1(&mut self, value: bool)

Set label 1 (clears other labels) or clear it.

pub fn set_label2(&mut self, value: bool)

Set label 2 (clears other labels) or clear it.

pub fn set_label3(&mut self, value: bool)

Set label 3 (clears other labels) or clear it.

pub fn set_label4(&mut self, value: bool)

Set label 4 (clears other labels) or clear it.

pub fn clear_labels(&mut self)

Clear all labels.

pub fn to_equipped(self) -> Self

Convert to equipped flags (clear backpack bit).

pub fn to_backpack(self) -> Self

Convert to backpack flags (set backpack bit).

Trait Implementations

impl Clone for StateFlags

fn clone(&self) -> StateFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateFlags

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

Formats the value using the given formatter.

impl Default for StateFlags

fn default() -> StateFlags

Returns the “default value” for a type.

impl From<StateFlags> for u32

fn from(f: StateFlags) -> Self

Converts to this type from the input type.

impl From<u32> for StateFlags

fn from(v: u32) -> Self

Converts to this type from the input type.

impl PartialEq for StateFlags

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

impl Eq for StateFlags

impl StructuralPartialEq for StateFlags