CSCI 160 projo1 Spring 2022 Project Assignment 1 Instructions Due Date: Tuesday, March 1, 2021 @ 11:59 PM Lab Objectives: - Practice creating simple Classes - Declare and instantiate several objects. - Improve understanding of Class design and how Java classes interact. - Gain additional experience working with an API. Book Material Covered: - Chapter 2, 3,7 To complete this assignment: Check out the projol directory from your SVN repository: https://csprojects.cs.ndsu.nodak.edu/csci160/2022 spring/svn/username/projol Read through all instructions and look over the assignment and make a quick mental estimate of how much time you expect proj01 to take you to complete. You should record this initial estimate in the projo1 Questions document. Use the Room, Exit, Item, Creature, and World Class APIs to create the following classes: O Room Exit O Item 0 Creature O World - Create a TextAdventure class that contains a main method to start the adventure. 0 You will declare an instantiate several objects of the classes you have written in this class. O Your adventure should include at least the following: - 10 different Rooms 3 different Items . 3 different Creatures Exits as necessary to connect the Rooms. Complete the Blackboard portion of the assignment by answering the questions listed in the projl Questions Word document. Compare the actual amount of time it took you to complete the assignment with your original estimate. This may be helpful for developing your estimation abilities going forward. Grading: - 40 points (Correctness of solution, following the API) - 30 points (Having at least the necessary number of Rooms, Items, Creatures, etc.) - 20 points (Proper WUUU TUTTUGIS. CU Trowing style conventions) Grading: - 40 points (Correctness of solution, following the API) - 30 points (Having at least the necessary number of Rooms, Items, Creatures, etc.) - 20 points (Proper formatting, using good identifiers, and following style conventions) - 10 points (Completing the Blackboard portion of the assignment) Assignment Description: For this assignment you will be creating several user-defined classes in order to create a simple object-oriented text adventure game. You will also be creating several instances of the classes you write to create a short text adventure. As part of your solution you will be using some provided classes including a Player class and a Game class, both of which are described in further detail below. These classes contain the code necessary to actually drive the game as we have not yet learned enough about coding in order to do this ourselves. A sample adventure game has been uploaded to Blackboard. Just download unzip the file, go into the TextAdventure folder and double click the Start file. Your adventure game can be about any topic manner you like, so be creative. Although we have not yet discussed how to write our own classes, you can use the API to begin constructing objects of those classes, even though you have not written them yet. Player Class Methods: The following methods of the Player will be necessary for you to complete the assignment: Identifier: Player(String name, String description) Parameters: name - A String representing the name of the player character. description - A String representing a description of the player character. Return Value: Other: Game Class Methods: The following methods of the Game class will be necessary for you to complete the assignment: Identifier: Game(World world, Player player) Parameters: player - A Player object representing the player character for this Game. world - A World object representing the world in which this Game takes place. Return Value: Other: Identifier: setStart Text(String text) Parameters: text - A String representing text to be displayed at the start of the Game. Return Value: Other: Identifier: set Victory Text(String text) Parameters: text - A String representing text to be displayed at the end of the Game. Return Value: Other: Identifier: start() Parameters: Return Value: Other: Calling this method on a Game object reference will cause the game to start and will accept text input until the game is finished. Class Descriptions: Room The Room class represents a single Room in the TextAdventure game, Rooms contain Exits to other Rooms, and optionally an Item that the Player can acquire or a Creature that the Player may need to defeat. Rooms also have a name and a description of the Room. A Room may also have a secret Exit that is not listed among the visible Exits. Exit The Exit class represents a path to another Room. Each Exit has a name and a description as well as which Room the Exit leads into and should also contain some additional text to display when moving through that Exit. An Exit can optionally require a specific Item in order to use or have passage through it blocked by a Creature in the Room containing the Exit. Note that an Exit only has one direction. Just because you can travel to a different Room through an Exit does not mean that you can travel back to the previous Room once you have arrived in the new Room. Item The Item class represents anything that the player can pick up or acquire. It doesn't actually need to be a physical object. Items are used to defeat Creatures or to use certain Exits. Creature The Creature class represents other entities or characters in the TextAdventure game. Creatures have a name and a description. Optionally creatures may be defeated when the player uses a specified Item while in the same Room as a Creature which will display a special message when the creature is defeated. World The World class represents a game world. It contains a Room where the player should start their adventure and a Room where the adventure will end. Player The Player class represents the player character. It has a name and a description of the player character as well as a description of the character. It also stores the player character's inventory, a collection of the different Items that the player character has picked up or is currently holding. The Game class contains all of the code necessary to drive the TextAdventure game. You do not need to modify any of the code in this class, but you may want to take a peek at it to see how it works. Game Controls: Controls: The following commands can be used while playing the game. look exit, item, creature> - Provides a description of an exit, item, or creature in a room. go exit - Travels through an exit. get - Picks up an item in a room and add it to your inventory. use item> - Uses an item in your inventory. inventory - Lists out any items being carried by the player. help - Prints out a list of game commands. Graphical Representation: The following is a brief graphical representation of how the different classes interact with each other. Room1 Exit1 Room2 Item1 Exit2 Creature1 Exit3 Exit 4 Exit 5 Room3 Room4 Exito Item2 Challenges: If you are experienced with coding, you may wish to extend the game further. Feel free to implement additional features into your game, such as allowing multiple Items or Creatures per Room or including additional ways to interact with those objects. You could add a score system that tracks a player's progress through the game. Adding the ability to die or otherwise lose the game may also be useful. You could even add RPG clements to the game to add further depth to the game or different solutions based on character attributes. Where to Start: It is recommended that you start be designing all of the different classes that you will need, based on the provided API documents. Once you have completed these, you can determine if you have followed the API be checking to see if there are any compiler errors in the Game class. Because the Game class contains code that assumes all of your classes were written according to the API, any compiler errors would indicate a missing or improperly specificd method in one or more of your classes. After resolving those issues, you may want to use a sheet of paper to plan out what your adventure will look like before Costess. That can help clarify Room1 Exit1 Room2 Item1 Exit2 Creature1 Exit3 Exit4 Exit 5 Room3 Room4 Exit 6 Item2 Challenges: If you are experienced with coding, you may wish to extend the game further. Feel free to implement additional features into your game, such as allowing multiple Items or Creatures per Room or including additional ways to interact with those objects. You could add a score system that tracks a player's progress through the game. Adding the ability to die or otherwise lose the game may also be useful. You could even add RPG elements to the game to add further depth to the game or different solutions based on character attributes. Where to Start: It is recommended that you start be designing all of the different classes that you will need, based on the provided API documents. Once you have completed these, you can determine if you have followed the API be checking to see if there are any compiler errors in the Game class. Because the Game class contains code that assumes all of your classes were written according to the API, any compiler errors would indicate a missing or improperly specified method in one or more of your classes. After resolving those issues, you may want to use a sheet of paper to plan out what your adventure will look like before you start creating instances of your class. That can help clarify your ideas as well as provide a map for how your various Objects will connect together. Once you have a design in mind, start be instantiating all of the different objects you will need. In some cases, not all of the values will be available. For example, if you make all of your Rooms before you make an Exits, there will not be any value to give to the constructor method for an Exit when you instantiate a Room object. This is okay, as you can always use your mutator methods to set those fields later once you have created all of your objects. Finally, you should play though your adventure in order to test it and make sure that it works properly. Make sure to test all of the different paths to look for unexpected crashes that can result if you haven't set up some of your objects properly. Page 5 of 5 Open in... Creature Class API Methods: Identifier: getName() Parameters: Return Value: String - A String representing the name of this Creature Other: Identifier: getDescription() Parameters: Return Value: String - A String representing a description of this Creature. Other: Identifier: getDefeated Texto Parameters: Return value: String - A String representing text to be displayed when this Creature is defeated. Other: Identifier: getItem To Destroy Parameters: Return Value: Item - The Item which is necessary to defeat this Creature. Other: Identifier: setItem ToDestroy(Item item) Parameters: item - An Item which will destroy (defeat) this Creature. Return Value: Other: Constructor Methods: There are no requirements for which constructor methods you create, but you will likely want to include a Constructor method which takes three String values as arguments for the name, description, and text to display when the Creature is defeated. Otherwise it will be necessary to include additional mutator methods to modify those properties. Page 1 of 1 Exit Class API Methods: Identificr: getNamco Parameters: Return Value: String - A String representing the name of the Exit. Other: Identifier: getDescription Parameters: Return Value: String - A String representing a description of the Exit. Other: Identifier getTransition() Parameters: Return Value: String - A String representing the text to display when moving through this Exit. Other: Identifier: getDestination Parameters: Return Value: Room - The Room to which this Exit connects. Other: Identifier: getRequireditemo Parameters: Return Value: Item The Item required to travel through this Exit. Other: Identifier: getCreatureBlocks Parameters: Return Value: boolean Whether or not a Creature in a Room will block this Exit. Other: Identifier: set Destination(Room destination) Parameters: destination - The Room where you will end up in when traveling through this Exit. Return value: Other: Identifier: setRequireditem(Item item) Parameters: item - The Item required to travel through this Exit. Return Value: Other: Identifier: setCreatureBlocks(boolean value) Parameters: Value - Whether or not a Creature in the Room will block travel through this Exit. Return Value: EXIT. Other: Identifier: getDestination) Parameters: Return Value: Room - The Room to which this Exit connects. Other: Identifier: getRequireditem() Parameters: Return Value: Item - The Item required to travel through this Exit. Other: Identifier: getCreatureBlocks Parameters: Return Value: boolean Whether or not a Creature in a Room will block this Exit. Other: Identifier: set Destination Room destination) Parameters: destination - The Room where you will end up in when traveling through this Exit Return value: Other: Identifier: setRequireditem(Item item) Parameters: item - The Item required to travel through this Exit Return Value: Other: Identifier: setCreatureBlocks(boolean value) Parameters: value - Whether or not a Creature in the Room will block travel through this Exit. Return value: Other: Constructor methods: There are no specific requirements for Constructor methods. It is suggested that you have a Constructor that takes arguments to specify the name, description, and transition text for the Exit or you will need to create additional mutator methods to modify those instance variables. Page 1 of 2 Item Class API Methods: Identifier: getName() Parameters: Return Value: String - A String representing the name of this Item Other: Identifier: getDescription() Parameters: Return Value: String - A String representing a description of this Item Other: Constructor Methods: Identifier: Item(String name, String description) Parameters: name A String representing the name of this Item description - A String representing a description of this Item Return value: Other: Page 1 of 1 Room Class API Methods: Identifier: getName Parameters: Return Value: String - A String representing the name of the Room. Other: Identifier: getDescription Parameters: Return Value: String - A String representing a description of the Room. Other: Identifier getExit10 Parameters: Return Value: Exit - The first Exit from this Room. Other: Identifier: getExit20 Parameters: Return Value: Exit -The second Exit from this Room. Other: Identifier: getExit30 Parameters: Return Value: Exit -The third Exit from this Room. Other: Identifier: getExit40 Parameters: Return Value: Exit The forth Exit from this Room, Other: Identifier: getSecretExit Parameters: Return Value: Exit -The secret Exit from this Room. Other: Identifier: getItem( Parameters: Return Value: Item - The Item currently in this Room. Other: Identifier: getCreature) Parameters: Return Value: Creature The Creature currently in this Room. Other: Identifier: setName(String new Name) Parameters: new Name - A String representing the new name for this Room. Return value: Other: Identifier: setDescription (String new Description) Parameters: new Description - A String representing the new description for this Room. Return value: Other: Identifier: setExit1(Exit exit) Parameters: exit - The Exit to which the first Exit in this Room should be set. Return Value: Other: Identifier: setExit2(Exit exit) Parameters: exit - The Exit to which the second Exit in this Room should be set. Return Value: Other: Identifier setExit3(Exit exit) Parameters: exit - The Exit to which the third Exit in this Room should be set. Return value: Other: Identifier setExit4(Exit exit) Parameters: exit - The Exit to which the forth Exit in this Room should be set. Return value: Other: Identifier SetSecretExit(Exit exit) Parameters: exit -The Exit to which the secret Exit in this Room should be set. Return Value: Other: Identifier: setltem(Item item) Parameters: item The Item to put in this Room Return value: Othe Identifier setCreature (Creature creature) Parameters: creature - The Creature to put in this Room. Return Value: Other: Constructor Methods. Other: Identifier: setExit2(Exit exit) Parameters: exit - The Exit to which the second Exit in this Room should be set. Return Value: Other: Identifier setExit3(Exit exit) Parameters: exit - The Exit to which the third Exit in this Room should be sct. Return value: Other: Identifier: sctExit4(Exit exit) Parameters: exit - The Exit to which the forth Exit in this Room should be set. Return value: Other: Identifier: setSecret Exit(Exit exit) Parameters: exit - The Exit to which the secret Exit in this Room should be set. Return Value: Other: Identifier: setItem(Item item) Parameters: item - The Item to put in this Room. Return value: Other: Identifier: setCreature (Creature creature) Parameters: creature - The Creature to put in this Room. Return Value: Other: Constructor Methods: There are no required constructor methods, however you may want to create multiple constructor methods that take varying degrees of parameters based on the types of Room objects you will need to construct. Page 1 of 3 World Class API Methods: Identifier: getStartingRoom) Parameters: Return Value: Room - The Room in which the adventure should start. Other: Identifier: getEndingRoom) Parameters: Return Value: Room - The Room in which the adventure should end. Other: Constructor Methods: Identifier: World(Room starting Room, Room endingRoom) Parameters: starting Room - The Room in this world in which the adventure starts. endingRoom - The Room in this world in which the adventure ends. Return Value: Other: Page 1 of 1