romkit 0.1.0

Identify game ROMs and extract their data and assets as structured files.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Items: 7-byte attribute records (price, held effect and its parameter, permissions, pocket,
//! and the menus that can use it), names in a list, and descriptions through a table of
//! addresses.

use serde::Serialize;

use super::ItemId;
use crate::Result;
use crate::io::Reader;

const RECORD_LEN: usize = 7;

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct Item {
    pub id: ItemId,
    pub name: String,
    pub description: String,
    pub price: u16,
    pub pocket: Pocket,
    /// The effect of holding it, and that effect's parameter.
    pub held_effect: u8,
    pub held_parameter: u8,
    /// Whether it can be tossed, selected, or registered, as flags.
    pub permissions: u8,
    /// How the bag uses it outside battle and in battle.
    pub field_menu: u8,
    pub battle_menu: u8,
}

raw_enum! {
    pub enum Pocket: u8 {
        Items = 1,
        KeyItems = 2,
        Balls = 3,
        Machines = 4,
    }
}

pub(super) fn parse(
    attributes: &[u8],
    names: &[String],
    descriptions: &[String],
) -> Result<Vec<Item>> {
    attributes
        .as_chunks::<RECORD_LEN>()
        .0
        .iter()
        .enumerate()
        .map(|(index, bytes)| {
            let mut record = Reader::new("Gen 2 item", bytes);
            let price = record.u16()?;
            let held_effect = record.u8()?;
            let held_parameter = record.u8()?;
            let permissions = record.u8()?;
            let pocket = Pocket::from_raw(record.u8()?);
            let menus = record.u8()?;
            Ok(Item {
                id: ItemId(index as u16 + 1),
                name: names.get(index).cloned().unwrap_or_default(),
                description: descriptions.get(index).cloned().unwrap_or_default(),
                price,
                pocket,
                held_effect,
                held_parameter,
                permissions,
                field_menu: menus >> 4,
                battle_menu: menus & 0xF,
            })
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_attributes() {
        let potion = [0x2C, 0x01, 0, 20, 0x40, 1, 0x55];
        let items = parse(&potion, &["POTION".to_owned()], &[]).unwrap();
        assert_eq!((items[0].price, items[0].pocket), (300, Pocket::Items));
        assert_eq!((items[0].field_menu, items[0].battle_menu), (5, 5));
    }
}