Programming Conventions

[thatcherty]

Proposed Conventions

• Class names in PascalCase
• variable names in camelCase
• methods/functions in snake_case()

Classes

• Player
  • private
    • name (string)
    • key (bool) if player has key for storage room
    • copilot (enum) {LOST, FOUND, INJURED}
    • puzzlePiece (bool)
    • location (enum) {ENGINE_ROOM, COCKPIT, HALLWAY, STORAGE_ROOM, MEDICAL_BAY, SLEEPING_QUARTERS}
  • public
    • set and get for all private var
    • get_copilot();
    • set_copilot();
    • get_key();
    • set_key()
• Engine Room
  • private
    • status (bool)
  • public
    • get_status() function returns status
    • set and get for all private var
• Cockpit
  • private
    • status (bool) for game_win
  • public
    • get_status() function returns status
    • set_status() ran each time cockpit entered, checks for copilot == FOUND && EngineRoom.get_status() == 1;
    • set and get for all private var
• Hallway
  • private
    • playerChoice (char)
  • public
    • loop() outputs movement options
    • set and get for all private var
• Storage Room
  • private
    • status (bool)
    • enemy (bool) for dead or alive
  • public
    • get_status() function returns status
    • set and get for all private var
    • loop() first check if player.copilot == FOUND, if not exit and output proper narrative
• Medical Bay
  • private
    • status (bool)
    • supplies (bool) used or unused
  • public
    • get_status() function returns status
    • set and get for all private var
    • loop()
      • sub function or statement to see if player.copilot == INJURED, then can use medical supplies
• Sleeping Quarters
  • private
    • status (bool)
  • public
    • get_status() function returns status
    • set and get for all private var
    • loop()
      • check if player.copilot != LOST

Game Loop Requirements

• while loop condition should check if variable such as game_win = 1 then stop;
• Cockpit will set game_win upon entry if conditions met
• Each room needs it's on loop, check for player exiting room. Player then prompted with main while loop beginning
• when a room status is 1, player should receive slightly different dialoug when entering
• player location tracker may be helpful, unsure if necessary

Important Game methods

• Player.get_copilot() value (check by medical bay, cockpit)
• Player.set_copilot() function (used by storage)
• Player.get_key() value (check by cockpit)
• Player.set_key() function (used by sleeping quarters)
• Player.get_puzzlePiece() value (check by engine room)
• Player.set_puzzlePiece() function (used by storage)

While Loop

while (Cockpit.get_status() != 1) {
    Hallway.loop();
    switch (Hallway.get_choice()) {
        case 'a':
            player.set_location() = ENGINE_ROOM;
            EngineRoom.loop();
            break;
        case 'b':
            player.set_location() = COCKPIT;
            Cockpit.loop();
            break;
        case ...:
            break;
        default:
            Hallway.movement();
            break;
    }
}

Function idea

void cockpit(&game_win, enigne_room.get_status(), player.get_copilot()) {
    output narrative;
    check conditions;
    return no value
}

Class idea

class Hallway {
    public:
        void movement(&char);

    private:
        char playerChoice;
}

void Hallway::loop(char &playerChoice) {
    output movement options;
    input validation;
    take player input > choice;
}

[thatcherty]

16 Provides the main.cpp and classes.cpp