#inventory #game #item #inventory-system

inv-sys

A simple and effective inventory system for games

10 releases (6 stable)

1.4.1 Dec 16, 2021
1.3.0 Dec 5, 2021
0.2.2 Nov 28, 2021
0.1.2 Nov 28, 2021
0.1.1 Feb 5, 2021

#89 in Game dev

Download history 31/week @ 2022-03-11 40/week @ 2022-03-18 8/week @ 2022-04-08 10/week @ 2022-04-22 50/week @ 2022-04-29 49/week @ 2022-05-06 172/week @ 2022-05-13 32/week @ 2022-05-20 80/week @ 2022-05-27 72/week @ 2022-06-03 3/week @ 2022-06-10 2/week @ 2022-06-17

157 downloads per month

MIT/Apache

19KB
552 lines

inv-sys

Latest Release Documentation

A robust and effective inventory system for games.

Features

  • simple but robust API
  • automatic stacking functionality
  • taking stacks
  • finding slots
  • iterator
  • max stacksize via trait
  • sorting
  • and more!

Usage

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum Item {
  Apple,
  Banana,
  Mango,
  Peach,
  Orange
}

/* 
* Implement the Stacksize trait for 
* your type that will act as your Item
*/
impl Stacksize for Item {
  fn get_max_stacksize(&self) -> usize {
    3
  }
}

fn main() {
  let mut inv = Inv::<Item>::new(32);

  // cant be placed, slot out of bounds
  assert_eq!(
    inv.stack_at(
      666, ItemStack::new(Item::Peach, 1)
    ),
    Err(InvAccessErr::SlotOutOfBounds)
  );

  // overflow, which is returned to you
  assert_eq!(
    inv.stack_at(
      2, ItemStack::new(Item::Apple, 4)
    ),
    Ok(Err(
      StackErr::StackSizeOverflow(
        ItemStack::new(Item::Apple, 1)
      )
    ))
  );

  // stack Banana at pos 1
  inv.stack_at(
    1, ItemStack::new(Item::Banana, 1)
  ).ok();
  
  // item cant be stacked, 
  // item type does not match (Banana != Orange)
  assert_eq!(
    inv.stack_at(
      1, ItemStack::new(Item::Orange, 1)
    ),
    Ok(Err(
      StackErr::ItemTypeDoesNotMatch(
        ItemStack::new(Item::Orange, 1)
      )
    ))
  );

  // auto stacking
  // this first fills slot 1 to be at the max of 3
  // since slot 1 already had 1 Banana in it
  // the leftover will be placed in the first available slot,
  // which, in this case, is 0
  assert!(
    inv.auto_stack(
      ItemStack::new(Item::Banana, 3)
    ).is_ok()
  );

  // 1 Banana, 3 Bananas
  assert_eq!(
    inv.get_slot(0), 
    Ok(&Slot::new(ItemStack::new(Item::Banana, 1)))
  );
  assert_eq!(
    inv.get_slot(1), 
    Ok(&Slot::new(ItemStack::new(Item::Banana, 3)))
  );

  // you can take a stack out of its slot
  // first, we place 2 Mangos at slot 5
  inv.stack_at(5, ItemStack::new(Item::Mango, 1)).ok();
  inv.auto_stack(ItemStack::new(Item::Mango, 1)).ok();

  // now we just take the stack
  assert_eq!(
    inv.take_stack(5), 
    Ok(ItemStack::new(Item::Mango, 2))
  );

  // slot 5 is empty now
  assert_eq!(
    inv.take_stack(5), 
    Err(InvAccessErr::SlotEmpty)
  );
}

You can look at the unit tests for more examples.

Todo

  • sorting
  • any requests? please just submit an issue, thanks!

Contributions

Feel free to open an issue/PR explaining possible improvements or changes

Help

Also, please do not hesitate and open an issue when needed. I am happy to help!

No runtime deps