zara 1.0.0

Zara survival engine
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
53
54
55
56
57
58
59

use crate::inventory::Inventory;
use crate::inventory::items::InventoryItem;
use crate::error::InventoryItemAccessErr;
use crate::utils::event::{MessageQueue, Event};

impl Inventory {
    /// Returns `true` if item of this kind exists in the inventory
    ///
    ///# Parameters
    ///- `item_name`: unique name of the item (item kind)
    pub fn has_item(&self, item_name: &String) -> bool {
        let b = self.items.borrow();

        b.contains_key(item_name)
    }

    /// Adds new item to the inventory and recalculates inventory weight
    ///
    /// # Parameters
    /// - `item`: any boxed object that supports `InventoryItem` trait
    ///
    /// # Notes
    /// Borrows the `items` collection
    pub fn add_item(&self, item: Box<dyn InventoryItem>) {
        let key = item.get_name();
        let key_for_message = item.get_name().to_string();

        self.items.borrow_mut().insert(key, item);
        self.recalculate_weight();

        self.queue_message(Event::InventoryItemAdded(key_for_message));
    }

    /// Removes item kind from the inventory and recalculates inventory weight
    ///
    /// # Parameters
    /// - `item_kind`: unique name of the item ("InventoryItem.name")
    ///
    /// # Returns
    /// Ok on success.
    ///
    /// # Notes
    /// Borrows the `items` collection
    pub fn remove_item(&self, item_kind: &String) -> Result<(), InventoryItemAccessErr> {
        let mut b = self.items.borrow_mut();

        if b.contains_key(item_kind) {
            b.remove(item_kind);

            self.recalculate_weight();

            self.queue_message(Event::InventoryItemRemoved(item_kind.to_string()));

            return Ok(());
        }

        return Err(InventoryItemAccessErr::ItemNotFound)
    }
}