Milestone 4:
Two more things:
1- Save/load features. You may use Java Serialization to achieve this.
2- Game level builder. The levels may be saved in XML. 5% overall project
bonus: try a real time version of the game and/or porting it to the Android platform.
• Deliverables: readme file + code + tests + documentation. Your project should be well packaged, and the program(s) should be easy to install and run.
• Deadline: Monday December 2nd. Weight: 35% of the overall project grade.
Group 6:
Amandeep Singh: Coding for Model,Controller classes readme file,UML diagrams and Reflection on design document.
Zoha Mehdi: Coding for View, Controller classes and writing the JUnit tests diagrams.
Toluwalope Ajisola: Commenting, indentatation and refactoring issues of the code.
James Desorsiers: Sequence Diagrams.
The ZIP file contains the a jar file that contains the code which is further on divided into different packages of classes acting as VIEW, classes acting as MODEL, the controller package consists of the controller class, tests for testing the sunflower class, Peashooter class, level class,Basic zombie class, getPlant class, Polezombie class, Snowshooter class and Explosive Zombie class. The ZIP file also contains the class diagram and the sequence diagrams under the diagrams folder. The new sequence diagrams for the save, load features have been added to this milestone other than the other old diagrams from the milestone 3 which have the same implementation in milestone 4 as well.
Different kinds of datastructures have been used for the Milestone.Including Arraylist that contains the Zombies,for storing different kind of characters in the game.Inheritance has been used in the game for the plants the zombies. All the different Plants have a superclass which they extend to and the same is implemented for different kind of zombies as well. We have also used the cloneable and serialization interfaces because When you use some marker interface(no method implementation ) you want to tell jvm or compiler for adding or checking something during runtime or compile time.
The Previous design for the milestone 1 consisted of the console game of the version which was using the classes like commandwords and were missing classes like peashooter, sunflowers. Milestone 2 contained the MVC design pattern for the plant and zombies which implements the step by step approach of the game instead of the real time version of the game. Milestone 3 resembles mostly all the classes from milestone 2, but with the addition of new kinds of plants and the zombies and the implementation of the undo /redo feature for the game moves. The code in milestone 2 had limited smelly code, and with good documentation and design techniques we can aso say that our code is not smelly at this point of the game for the Milestone 3.We were trying new level option for the game in milestone 2, but it doesn’t work for now. So, for this part of the game we have moved out the new level option from the menuBar, which will come back in milestone 4. The Zombie health has also been moved from 1 shot from previous iteration to the 3 shots for the basic zombies, and the health factor has been added for the different zombies.
KNOWN ISSUES: The game works perfectly fine but it has some issues some random times like mostly at the starting of the game, if we run out of the sun Points i.e. sun Points become 0 then the game is stuck neither we lose nor we can make a move to quit or lose. So, that’s a big known issue that we tackle when we run out of the sun Points. We could'nt figure out this error that right now. As the zombies are randomly produced using the random number generator so sometimes the game acts a bit weird and the zombies come to the field very late whereas 9/10 times the game works perfectly fine and the zombies come on the field after putting approximately 4-5 sunflowers and 3-5 peashooters on the field.The Save and load feature that have added to the game works perfectly fine but the implementation of the game level builder doesn't work.
MODEL PACKAGE: The model package contains the model class that deals with methods that add zombie on the field , buying a plant,place a plant on the field after you bought it, check if the the zombies have reached the end and we lose the game or we killed all the zombies, returning the sun points , the returning at what level we are present right now. THe Character class is the another important class that has the common functions for both plants and zombies.Basically it acts as a superclass for all the plants and zombies. The Level class contains the data associated with the current level. Then the sunflower, plant, zombies,,explosive zombie class and zombie class that contains the different kind plant price, and the other methods related to plant and zombies.The Undoredo class deals with the implementation of the undo and redo and contains the undo / redo button, uses stack for the purpose of undoing the steps and redoing the steps. The Model class also contains the new plants that we added to the game as a part of milestone 3,Snowshooter and Walnut are the plants that we added to the game. Walnuts have hard shells which you can use to protect your other plants. The snowshooters shoot frozen peas that damage and slow the enemy. Different kinds of zombies added to the pvz game are Polezombie and explosive zombie.PoleZombie absorbs 340 damage per shot and he degrades upon absorbing 180 damage per shot before dying at 340 damage per shot. When he approaches most plants, Pole Vaulting Zombie will vault over the plant and abruptly lose his pole. His speed will become normal upon losing the pole.The writeObject and readObject method writes the specified object to the ObjectOutputStream and ObjectInputStream. The class of the object, the signature of the class, and the values of the non-transient and non-static fields of the class and all of its supertypes are written. Default serialization for a class can be overridden using the writeObject and the readObject methods. The new Level doesn't work but the coding for the the creation for the new level has been done in the createLevel class.
VIEW PACKAGE: contains the classes that act as different panel for the main FRAME. The Plant panel contains the JButton for the sunflower, the peashooter. The MenuBar class contains the menubar for the frame that conatins new level, new and exit where new level doesn't work. The mainPanel class contains the grid layout for the game. The mainframe class contains where we add all the panels, gamePanel,statusPanel and other panels and set their layout.The view class is the main class that contains all the main Jframe that contains the grid and the plants the menuBar and the status Panel containing the sunPoints.The View package the contains the almost the same code as milestone 2 except the new buttons for the undo,redo and the skipTurn have been added to the game. The newlevel,the Save and Load menuitems have been added to the View package.
CONTROLLER PACKAGE : Contains only the controller class is responsible to handle all the events caused by the view using the MVC style. The undo,redo and skipturn features as methods have been added to the controller class to pass on the message to model, that we want to implement the following command. In the actionPerformed methods which will handle all the events caused by the view using the MVC style, we have added two else if statements for the save and load feature of the game.
TESTS PACKAGE: The tests package contains all the valid tests for the different kinds of plants and the zombies.
REFLECTION ON DESIGN: This document explains about how we personally feel about the code and design of the game as well as the stages of advancement of the Project.
The User Visible changes for the game: The newLevel, save and load has been added to the menubar for this milestone. The Class diagrams differs a bit from milestone 3, as we have added the methods for the save and load feature to the model, controller and the view class.
The Roadmap ahead for the game is to fix some random occurring errors in the code.
HOW TO USE THE GAME: So ,we have to go to the MenuBar and click on the new which would start the new game. Then, we can add plants and peashooters to the field while the zombies enter the field. We initially start with 10 sunPoints then as we buy the sunflower we get hike in points and we have with every 3 turns we get hike of some sun points. We can both LOSE and WIN the Game.
Reflection on the design of the Plants and Zombies game:
For the coding of the game we have used various concepts that were taught during the entire course like junit testing, GUI, the design pattern MVC that we used for the game, the UML diagram cycle and the other design principles like loose coupling ,high cohesion and etc that have been used in the coding of the Game.
Starting with Milestone 1, we made a console version that just contained that model class(from which most of implementation of game came from) along with the helper classes like one kind of the plant and one type of zombie were implemented along with basic methods like shoot,attack and etc. According to the software engineering design principles Milestone 1 for our group was a bad design as our code was violating the law of demeter, the code was tightly coupled .
For Milestone 2, we changed the design of the game making the game more right according the design principles and made a GUI(Graphical User Interface) version of the game following the MVC design pattern . For milestone 2, we used array for the view GRID system, array for storing zombies , array for storing different types of characters like plants, zombies which made the code more loose coupled and hence decreasing the dependency of classes on each other.This accounted to a better design of the game for Milestone 2 , along with JUNIT tests that uses the bogus parameter for different kind of plants and zombies.
Milestone 3 was implementing the undo and the redo feature of the game, for which we implemented the stack and made a separate class for the undo and redo , as a practise to good design techniques for the game.
Moving on to Milestone 4,we added the save and load and feature to the game that we implemented using the writeObject and readObject method that writes the specified object to the ObjectOutputStream and ObjectInputStream. The class of the object, the signature of the class, and the values of the non-transient and non-static fields of the class and all of its supertypes are written. We have also used the cloneable and serialization interfaces because When you use some marker interface(no method implementation ) you want to tell jvm or compiler for adding or checking something during runtime or compile time. But, unfortunately, we could not make the new level to work, but the coding for the creating the level is in createLevel class and level classes. Probably, there some minute bug in the createLevel class because of which the new level was left in non working condition (KNOWN ISSUE). Beside, the game work perfectly fine and very less random errors that pop up once in while.
What do we like or dislike about the code of the game and the game in general ?
The Project overall was a great learning process for all the members of our group which was finished successfully except we could'nt make the new Level to work. Taking a look at at code, we can say the code follows the major design design principles which are a learning outcome of this course. But ,looking at the pieces itself the code smells a bit in the controller and the model class which sometimes becomes hard to understand due to a lot of if's and else if's in the code. We could'nt figure out another effective way to do it without messing the game up. From, day one we have tried to keep the code less smelly as possible. To some some extent we have been effective too. Another thing that we think could have improved that cohesion of the game , the methods and the data in the model package escpecially the model, character class are doing more than they these classes are required. Because of time constraint, we were unable to make it highly cohesive. Another one thing that we would want to do was to add more plants and zombies to game and then convert it real time version( to make it look like a real game) , we would definitely work on that in the following summer. Sometimes, they are some random errors at the start of the game that we would want to figure out to fix the bugs in the game.Other than, it was a great learning process to learn software engineering principles by the means of this Game.