♻️ refactor

main
_ 2021-10-29 12:09:11 -05:00
parent 614787b94b
commit 741fc8171a
4 changed files with 202 additions and 188 deletions

View File

@ -1,57 +1,14 @@
mod player_actions;
mod responses;
mod room_1;
mod state; mod state;
use player_actions::*;
use responses::*;
pub use responses::Response;
pub use state::State; pub use state::State;
fn print_help () -> Response {
Response::PrintMany (vec! [
"All commands are ASCII and case-insensitive.",
"Commands should start with a verb like LOOK.",
"e.g. `look table`",
"Single-word verbs are better, e.g. prefer `hint` over `give me a hint`",
"When in doubt, try generic verbs like `look` or `use` over specific verbs like `actuate`, `type`, or `consolidate`.",
])
}
fn line_response <S: Into <String>> (line: S) -> Response {
Response::Print (line.into ())
}
fn undetected_item () -> Response {
line_response ("That ITEM does not exist in this ROOM, or you have not noticed it.")
}
fn just <T> (t: T) -> Vec <T> {
vec! [t]
}
#[derive (Debug, PartialEq)]
enum PlayerAction {
Quit,
Help,
Nonsense,
RoomSpecific (PlayerActionRoomSpecific),
}
#[derive (Debug, PartialEq)]
enum PlayerActionRoomSpecific {
Hint,
Wait,
Look (ItemName),
LookAround,
Use (ItemName),
}
#[derive (Clone, Copy, Debug, PartialEq)]
enum ItemName {
Nonsense,
Door,
EmergencyExit,
Keypad,
Note,
Table,
}
fn _item_name_display (x: ItemName) -> &'static str { fn _item_name_display (x: ItemName) -> &'static str {
match x { match x {
ItemName::Nonsense => "NONSENSE", ItemName::Nonsense => "NONSENSE",
@ -137,6 +94,7 @@ fn parse_item_name (s: &str) -> ItemName {
} }
} }
#[macro_export]
macro_rules! require_detection { macro_rules! require_detection {
($condition:expr $(,)?) => { ($condition:expr $(,)?) => {
if ! $condition { if ! $condition {
@ -148,31 +106,6 @@ macro_rules! require_detection {
}; };
} }
/// Commands that the game will ask the runtime to execute.
#[derive (PartialEq)]
pub enum Response {
/// Print a line of text
Print (String),
/// Print many lines of unformatted text
PrintMany (Vec <&'static str>),
/// Sleep for x milliseconds
Sleep (u32),
/// Quit the game
Quit,
// These are just useful markers for the automated tests
JokeEnding,
FailedDetectionCheck,
PlayerVictory,
// These are hints for spam detection on the Telnet frontend
Nonsense,
}
impl State { impl State {
pub fn cheat (&mut self) { pub fn cheat (&mut self) {
self.current_room = state::RoomName::SortingRoom; self.current_room = state::RoomName::SortingRoom;
@ -261,119 +194,6 @@ impl State {
}, },
} }
} }
fn room_1 (&mut self, action: PlayerActionRoomSpecific) -> Vec <Response> {
use PlayerActionRoomSpecific::*;
match action {
Hint => {
just (line_response ("Hint for this room: Try using the `help` command."))
},
Wait => {
just (line_response ("You wait around a bit. You can hear humming from the electrical lights, and the distant rumble of the building's HVAC system. The room smells faintly of fresh paint. Nothing has changed."))
},
LookAround => {
let mut output = vec! [
line_response ("You are in a small room. In one corner is a TABLE. Obvious exits are a DOOR, and an EMERGENCY EXIT."),
];
if self.room_1.detected_note {
output.push (line_response ("You have noticed a NOTE on the TABLE."));
}
if self.room_1.detected_keypad {
output.push (line_response ("You have noticed the DOOR is locked by an electronic KEYPAD."));
}
output
}
Look (item_name) => match item_name {
ItemName::Door => {
self.room_1.detected_keypad = true;
just (line_response ("You examine the DOOR. It is firmly locked, and you don't have any lock-picking tools. On the DOOR is an electronic KEYPAD."))
},
ItemName::EmergencyExit => just (line_response (
"The EMERGENCY EXIT reads, \"Emergency exit. Push bar to open. Alarm will sound. Door will unlock in 10 seconds.\". The EMERGENCY EXIT is period-accurate for an American Wal-Mart c. 2020 C.E."
)),
ItemName::Keypad => {
require_detection! (self.room_1.detected_keypad);
just (line_response ("The DOOR is locked by an electronic KEYPAD. A soft amber power light indicates that the KEYPAD is likely functional. The KEYPAD buttons are the digits 0-9, Enter, and Clear. Experience tells you that the key code is likely 4 or 5 digits long."))
},
ItemName::Note => {
require_detection! (self.room_1.detected_note);
self.room_1.read_note = true;
just (Response::PrintMany (vec! [
"You read the NOTE.",
"",
"Welcome to SEROTONIN DEPOSITORY.",
"As you play, keep in mind:",
"- LOOKing at ITEMS is not always safe",
"- TAKEing an item may be bad long-term",
"- WAITing counts as an action",
"- LOOKing AROUND is always safe",
"- Other NOTEs may contain non-truths",
"The code for this first KEYPAD is 1234.",
"",
" -- Phayle Sayf",
"",
"You notice that the NOTE is _not_ period-accurate.",
]))
},
ItemName::Table => {
self.room_1.detected_note = true;
just (line_response ("You look at the TABLE. Your instincts tell you that it is period-accurate. Upon the TABLE sits a NOTE."))
},
_ => just (undetected_item ()),
},
Use (item_name) => match item_name {
ItemName::Door => {
let mut output = vec! [
line_response ("You can't USE the DOOR, it is locked."),
];
if ! self.room_1.detected_keypad {
self.room_1.detected_keypad = true;
output.push (line_response ("You notice an electronic KEYPAD on the DOOR."));
}
output
},
ItemName::EmergencyExit => vec! [
line_response ("You push on the emergency exit. An alarm starts sounding. Your ADVENTURE GAME ENTHUSIAST friend is going to be very mad at you."),
Response::Sleep (5000),
line_response ("The alarm is still sounding. You are getting embarrassed, but you have committed to this path of action."),
Response::Sleep (5000),
line_response ("The emergency exit unlocks, and you walk out of the game. Bye."),
Response::JokeEnding,
Response::Quit,
],
ItemName::Keypad => {
require_detection! (self.room_1.detected_keypad);
if ! self.room_1.read_note {
return just (line_response ("You can't USE the KEYPAD, you don't know the code for it. You would normally try guessing, but it would take the programmer all day to implement that level of interaction."));
}
vec! [
line_response ("You USE the code on the KEYPAD. The door opens, and the game immediately crashes."),
Response::PlayerVictory,
Response::Quit,
]
},
ItemName::Note => {
require_detection! (self.room_1.detected_note);
just (line_response ("You can't think of any way to USE the NOTE that would be better than LOOKing at it to read it."))
},
ItemName::Table => just (line_response (
"You can't think of any way to USE the TABLE that would be better than LOOKing at it."
)),
_ => just (undetected_item ()),
},
}
}
} }
#[cfg (test)] #[cfg (test)]

View File

@ -0,0 +1,27 @@
#[derive (Debug, PartialEq)]
pub enum PlayerAction {
Quit,
Help,
Nonsense,
RoomSpecific (PlayerActionRoomSpecific),
}
#[derive (Debug, PartialEq)]
pub enum PlayerActionRoomSpecific {
Hint,
Wait,
Look (ItemName),
LookAround,
Use (ItemName),
}
#[derive (Clone, Copy, Debug, PartialEq)]
pub enum ItemName {
Nonsense,
Door,
EmergencyExit,
Keypad,
Note,
Table,
}

46
game/src/responses.rs Normal file
View File

@ -0,0 +1,46 @@
/// Commands that the game will ask the runtime to execute.
#[derive (PartialEq)]
pub enum Response {
/// Print a line of text
Print (String),
/// Print many lines of unformatted text
PrintMany (Vec <&'static str>),
/// Sleep for x milliseconds
Sleep (u32),
/// Quit the game
Quit,
// These are just useful markers for the automated tests
JokeEnding,
FailedDetectionCheck,
PlayerVictory,
// These are hints for spam detection on the Telnet frontend
Nonsense,
}
pub fn print_help () -> Response {
Response::PrintMany (vec! [
"All commands are ASCII and case-insensitive.",
"Commands should start with a verb like LOOK.",
"e.g. `look table`",
"Single-word verbs are better, e.g. prefer `hint` over `give me a hint`",
"When in doubt, try generic verbs like `look` or `use` over specific verbs like `actuate`, `type`, or `consolidate`.",
])
}
pub fn line_response <S: Into <String>> (line: S) -> Response {
Response::Print (line.into ())
}
pub fn undetected_item () -> Response {
line_response ("That ITEM does not exist in this ROOM, or you have not noticed it.")
}
pub fn just <T> (t: T) -> Vec <T> {
vec! [t]
}

121
game/src/room_1.rs Normal file
View File

@ -0,0 +1,121 @@
use crate::{
player_actions::*,
responses::*,
require_detection,
state::State,
};
impl State {
pub fn room_1 (&mut self, action: PlayerActionRoomSpecific) -> Vec <Response> {
use PlayerActionRoomSpecific::*;
match action {
Hint => {
just (line_response ("Hint for this room: Try using the `help` command."))
},
Wait => {
just (line_response ("You wait around a bit. You can hear humming from the electrical lights, and the distant rumble of the building's HVAC system. The room smells faintly of fresh paint. Nothing has changed."))
},
LookAround => {
let mut output = vec! [
line_response ("You are in a small room. In one corner is a TABLE. Obvious exits are a DOOR, and an EMERGENCY EXIT."),
];
if self.room_1.detected_note {
output.push (line_response ("You have noticed a NOTE on the TABLE."));
}
if self.room_1.detected_keypad {
output.push (line_response ("You have noticed the DOOR is locked by an electronic KEYPAD."));
}
output
}
Look (item_name) => match item_name {
ItemName::Door => {
self.room_1.detected_keypad = true;
just (line_response ("You examine the DOOR. It is firmly locked, and you don't have any lock-picking tools. On the DOOR is an electronic KEYPAD."))
},
ItemName::EmergencyExit => just (line_response (
"The EMERGENCY EXIT reads, \"Emergency exit. Push bar to open. Alarm will sound. Door will unlock in 10 seconds.\". The EMERGENCY EXIT is period-accurate for an American Wal-Mart c. 2020 C.E."
)),
ItemName::Keypad => {
require_detection! (self.room_1.detected_keypad);
just (line_response ("The DOOR is locked by an electronic KEYPAD. A soft amber power light indicates that the KEYPAD is likely functional. The KEYPAD buttons are the digits 0-9, Enter, and Clear. Experience tells you that the key code is likely 4 or 5 digits long."))
},
ItemName::Note => {
require_detection! (self.room_1.detected_note);
self.room_1.read_note = true;
just (Response::PrintMany (vec! [
"You read the NOTE.",
"",
"Welcome to SEROTONIN DEPOSITORY.",
"As you play, keep in mind:",
"- LOOKing at ITEMS is not always safe",
"- TAKEing an item may be bad long-term",
"- WAITing counts as an action",
"- LOOKing AROUND is always safe",
"- Other NOTEs may contain non-truths",
"The code for this first KEYPAD is 1234.",
"",
" -- Phayle Sayf",
"",
"You notice that the NOTE is _not_ period-accurate.",
]))
},
ItemName::Table => {
self.room_1.detected_note = true;
just (line_response ("You look at the TABLE. Your instincts tell you that it is period-accurate. Upon the TABLE sits a NOTE."))
},
_ => just (undetected_item ()),
},
Use (item_name) => match item_name {
ItemName::Door => {
let mut output = vec! [
line_response ("You can't USE the DOOR, it is locked."),
];
if ! self.room_1.detected_keypad {
self.room_1.detected_keypad = true;
output.push (line_response ("You notice an electronic KEYPAD on the DOOR."));
}
output
},
ItemName::EmergencyExit => vec! [
line_response ("You push on the emergency exit. An alarm starts sounding. Your ADVENTURE GAME ENTHUSIAST friend is going to be very mad at you."),
Response::Sleep (5000),
line_response ("The alarm is still sounding. You are getting embarrassed, but you have committed to this path of action."),
Response::Sleep (5000),
line_response ("The emergency exit unlocks, and you walk out of the game. Bye."),
Response::JokeEnding,
Response::Quit,
],
ItemName::Keypad => {
require_detection! (self.room_1.detected_keypad);
if ! self.room_1.read_note {
return just (line_response ("You can't USE the KEYPAD, you don't know the code for it. You would normally try guessing, but it would take the programmer all day to implement that level of interaction."));
}
vec! [
line_response ("You USE the code on the KEYPAD. The door opens, and the game immediately crashes."),
Response::PlayerVictory,
Response::Quit,
]
},
ItemName::Note => {
require_detection! (self.room_1.detected_note);
just (line_response ("You can't think of any way to USE the NOTE that would be better than LOOKing at it to read it."))
},
ItemName::Table => just (line_response (
"You can't think of any way to USE the TABLE that would be better than LOOKing at it."
)),
_ => just (undetected_item ()),
},
}
}
}