bfbb 0.3.0

Library for interacting with SpongeBob SquarePants: Battle for Bikini Bottom
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Implementation of a mock backend for [`GameInterface`]
//!
//! This may be useful for testing logic against some known state.

use bytemuck::CheckedBitPattern;
use strum::IntoEnumIterator;

use crate::{
    endian::EndianAware,
    game_interface::{
        game_var::{GameVar, GameVarMut, InterfaceBackend},
        GameInterface, Hans, PowerUps, Task, Tasks,
    },
    game_state::{GameMode, GameOstrich, GameState},
    Level, Spatula,
};

/// A mock implementation for [`InterfaceBackend`]
pub enum MockBackend {}
impl InterfaceBackend for MockBackend {
    type Var<T: CheckedBitPattern + EndianAware> = MockVar<T>;
    type Mut<T: CheckedBitPattern + EndianAware> = MockVar<T>;
}

impl Default for GameInterface<MockBackend> {
    fn default() -> Self {
        Self {
            is_loading: MockVar::default(),
            game_state: MockVar::new(GameState::Play),
            game_mode: MockVar::new(GameMode::Game),
            game_ostrich: MockVar::new(GameOstrich::InScene),
            hans: Hans::new(),
            powers: PowerUps::new(),
            scene_id: MockVar::new(Level::SpongebobHouse.into()),
            spatula_count: MockVar::default(),
            tasks: Tasks::new(),
            lab_door_cost: MockVar::new(74),
        }
    }
}

impl Tasks<MockBackend> {
    fn new() -> Self {
        Self {
            arr: Spatula::iter()
                .map(|s| {
                    (
                        s,
                        Task {
                            menu_count: MockVar::default(),
                            flags: Some(MockVar::default()),
                            state: Some(MockVar::default()),
                        },
                    )
                })
                .collect(),
        }
    }
}

impl Hans<MockBackend> {
    fn new() -> Self {
        Self {
            flags: MockVar::new(3),
        }
    }
}

impl PowerUps<MockBackend> {
    fn new() -> Self {
        Self {
            bubble_bowl: MockVar::default(),
            cruise_bubble: MockVar::default(),
            initial_bubble_bowl: MockVar::default(),
            initial_cruise_bubble: MockVar::default(),
        }
    }
}

/// A mock implementation for [`GameVar`] and [`GameVarMut`]
#[derive(Default)]
pub struct MockVar<T> {
    /// The mocked value. Accessing the value here directly allows setting up a scenario for a test,
    /// including the ability to mutate [`GameVar`]s that normally are immuatble.
    pub value: T,
}

impl<T> MockVar<T> {
    fn new(value: T) -> Self {
        Self { value }
    }
}

impl<T: CheckedBitPattern + EndianAware> GameVar for MockVar<T> {
    type Target = T;

    fn get(&self) -> crate::game_interface::InterfaceResult<Self::Target> {
        Ok(self.value)
    }
}

impl<T: CheckedBitPattern + EndianAware> GameVarMut for MockVar<T> {
    fn set(&mut self, value: Self::Target) -> crate::game_interface::InterfaceResult<()> {
        self.value = value;
        Ok(())
    }
}