bevy_adventure 0.6.0

A framework for building adventure games in Bevy.
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

use crate::Item;

/// A reference to an item, passed into an Interactive.
///
/// Allows the Interactive to optionally consume the item when used.
pub struct ItemRef<'a> {
    item: &'a Item,
    consumed: bool,
}

impl<'a> ItemRef<'a> {
    /// Create a new `ItemRef`, given a borrowed item name.
    pub fn new(item: &'a Item) -> Self {
        Self {
            item,
            consumed: false,
        }
    }

    /// Consume the item, remove it from the player's inventory.
    pub fn consume(&mut self) {
        self.consumed = true;
    }

    /// Reverse the consumption of an item.
    pub fn restore(&mut self) {
        self.consumed = false;
    }

    /// Returns whether the item has been consumed or not.
    pub fn consumed(&self) -> bool {
        self.consumed
    }

    /// Returns the item name, as a str.
    pub fn as_str(&self) -> &str {
        self.item.as_str()
    }
}