game_inventory 1.0.2

An inventory system independant of item data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# game_inventory

A framework for generalizing inventory logic and abstracting it away from
item data in your specific game.

See more examples and specific documentation about this crate on [docs.rs](https://docs.rs/game_inventory/latest/game_inventory/).

## Basic usage

```rs
use game_inventory::traits::{Item, ItemInstance, Slot};
use game_inventory::sample_structs::{DefaultItemInstance, DefaultSlot};
use game_inventory::helpers::add_to_inventory;
// Define your item data however you like.
#[derive(Debug)]
pub struct DefaultItem<'a> {
    pub name: &'a str,
    pub max_quantity: u16,
    pub image: Option<Vec<(u8,u8,u8,u8)>>,
    pub item_type: &'a str
}
// implement Item for it so it can interact with the rest of the system.
impl<'a> Item for DefaultItem<'a> {
    fn stackable(&self) -> bool {
        self.max_quantity > 1
    }
    fn max_quant(&self) -> u16 {
        self.max_quantity
    }
    fn name(&self) -> &str {
        self.name
    }
}
// start using it in combination with everything else!
const CHEESE: DefaultItem = DefaultItem{name:"Cheese", max_quantity:100, image:None, item_type:"Food"};
const CHEESE_INST: Option<DefaultItemInstance> = Some(DefaultItemInstance{item:&CHEESE, quantity:32});
const SWORD: DefaultItem = DefaultItem{name:"Sword", max_quantity:0, image:None, item_type:"Weapon"};
const SWORD_INST: Option<DefaultItemInstance> = Some(DefaultItemInstance{item:&SWORD, quantity:0});
let mut inventory = vec![
    DefaultSlot::new(CHEESE_INST),
    DefaultSlot::new(None),
    DefaultSlot::new(None),
    DefaultSlot::new(CHEESE_INST)
];
add_to_inventory(&mut inventory, SWORD_INST.unwrap());
assert_eq!(inventory[0].item_instance().unwrap().item().id(), CHEESE.id());
assert_eq!(inventory[0].item_instance().unwrap().quant(), CHEESE_INST.unwrap().quant());
assert_eq!(inventory[1].item_instance().unwrap().item().id(), SWORD.id());
assert!(inventory[2].item_instance().is_none());
assert_eq!(inventory[3].item_instance().unwrap().item().id(), CHEESE.id());
assert_eq!(inventory[3].item_instance().unwrap().quant(), CHEESE_INST.unwrap().quant());
```