CPSC 233: Assignment 5

New Concepts to be applied for the assignment

• Inheritance
• Software reuse
• Representing hierarchical class relationships in UML
   

Introduction

Among science fiction programs the Star Trek universe has one of the largest and most diverse set of alien races. Although many of them are largely humanoid (bipedal and approximately the size and mass of an average human) some are quite exotic: silicon-based "rock monsters", many gaseous life forms (e.g., the Calamarian), energy-based entities like the Medusans whose appearance is so alien that they drive most humanoids to madness when viewed, even ones that have no fixed shape or form such as the allasomorphs or the changelings but can change their appearance at will. Each has their own unique characteristics, culture, history and technology.

The Federation

The United Federation of Planets (or "the Federation" for short) is an egalitarian union of hundreds of species and cultures.  To bring together such a large and diverse number of races  requires something other than combat to settle differences of opinion.  One of the founding races of the Federation and perhaps the most ubiquitous are humans.  Most humans are equal parts explorer and diplomat, and provide the glue that holds the Federation together. Their ships are well equipped with defensive and offensive weapons that aren't designed to start a fight but to end them.

The federation is a peaceful union of numerous races.  "Infinite diversity in infinite combinations."

The Klingon Empire

This warrior race has a genetic predisposition to hostility and a well-known streak of fatalism.  Klingons are also famous (or perhaps infamous) for their celebrations in which there's a great deal of boasting, growling, wrestling, snarling and all-around extroverted revelry.   If you look beyond their boisterous and rather loud exteriors the Klingons are perhaps the most noble race of all: they hold honor above everything (even their own life).  Klingon ships are equipped with powerful offensive capabilities that suit their aggressive natures.

A young Klingon warrior wielding a Bat'leth in mock combat. "Kapla!" (Success!)

The Dominion

The Dominion is a mighty planetary alliance composed of several hundred dominated races led by a race of shape shifters (know as the "Founders" or changelings), administered by a devious and cloned race (the "Vorta") and defended by a genetically bred race of soldiers (the "Jem'Hadar").  The founders are the dominion and dominion are the founders.  Their goals are simple: the imposition of (their) order on the galaxy.  Much like Klingon warships, Dominion ships are built for a fight.

A Jem'Hadar soldier on guard. "Victory is life!"

The Borg

They are a cybernetic life-form which is part organic, part artificial with a singular unifying goal, the consumption of useful technology.  They do this by "assimilating" other species (i.e., turning them into Borg) which they claim will, "..raise the quality of life for that species."¹ The Borg skill at assimilating new technology allows their ships to adapt their defensive systems which will reduce the effectiveness of some enemy attacks over time.  Each attack on a Borg ship allows  them to adapt their defenses to the attack.  In addition the Borg are not native to the Federation quadrant (quarter) of the galaxy: only the advanced Borg propulsion systems in their ships have made contact between humans and the Borg possible.

A squad of Borg drones. "You will be assimilated. Resistance is futile."

Your mission for this assignment

You are to take your program from the previous assignment and augment it by implementing special classes of ships that extend the basic "StarShip" class from the first assignment.  In the full version of the game the human player will control a Federation star ship while the computer-controlled ships will include: the Klingon empire, the Dominion and the Borg. The 'cheat' capabilities will be greatly expanded. (You will need them).

Features needed from Assignment 4

• Your program implements all the required classes from the previous assignment.
• Classes are instantiated and properly initialized e.g., For class galaxy the human player always starts off in the Terrain sector while the starting positions for the computer controlled ships is randomly determined.
• The program displays the galaxy along with the bounding boxes around each sector and numbering for each row and column. 
• The program displays the movement menu and the attack menu.
• The human player's ship can warp to any adjacent and unoccupied square.
• The user can quit the game from either the movement or the attack menu.
• The human player's ship and computer-controlled ships can attack and destroy each other if they are adjacent.
• The program can detect and indicate to the user when the game is lost (the human controlled ship is destroyed) or won (all computer-controlled ships destroyed).  A player can also quit the game without the win or lose condition being met.

New features for Assignment 5

1. Expanded cheat options. Game cheats have been expanded so when the user enters zero at the attack or movement menu, a full blown "cheat menu" will come up:

Menu option	Effect
Invulnerability (option 'I')	The player's ship becomes immune to all attacks until the player invokes the cheat menu again and turns off invulnerability mode.
Invoke the quantum slip stream drive (option 'S')	A very high speed means of travel allowing the player's ship to move to any unoccupied sector in the galaxy. When invoked the program will prompt the player to enter the destination (row, column) values and if the sector is unoccupied the player's ship will move to the new sector. The ship cannot open a slip stream tunnel to the current sector. This is a separate means of propulsion from the regular engine and conceivably both can be invoked during a turn e.g., during the movement phase the player moves one sector using conventional warp drive while for the attack phase the player invokes the slip stream drive and moves to yet another sector.
Fire the photonic cannon (option 'P')	The player's ship discharges a high-energy burst that will totally destroy any ship, anywhere in the galaxy (except for the player's ship of course).  The firing of the photonic cannon is independent of the firing of the other weapons.  If the player invokes cheat mode during the movement menu and fires the photonic cannon, the phasers and the quantum torpedo (for the latter weapon refer to the description of the Federation star ship) can also be fired during the attack phase.
Enter debugging mode (option 'D')	It's to be implemented in a fashion similar to the previous assignment (off by default, and when turned on it will display debugging messages to help you find the errors in your program. Because of the many new features to be implemented for this assignment, the information displayed while debug mode is turned on is now more specific than it was with the previous assignment.  This will help speed up marking.
Quit the cheat menu (option 'Q')	Invoking the cheat menu will use up some time in the game. That means that if the cheat menu was invoked from the movement menu then exiting the cheat menu (either by selecting quit or another option) will return the player to the attack menu (and vice versa).

2. Create a Federation star ship. You are to implement a new class, "FederationStarShip", that extends class "StarShip".  This ship will replace the basic star ship that was controlled by the human player in the previous assignment.  The Federation star ship has all the features of the basic star ship except:
   • It has an onscreen appearance of 'F'.
   • The shield to hull ratio is 15 instead of 10.  (The hull value is still 400 points but now the maximum shield value is 400 x 15 = 6000 points).
   • Regenerative shielding:  If the current shield value is less than the maximum of 6000, at the end of each turn the shields will regenerate by 10% of the maximum shield value up to (but not exceeding) the original maximum shield value.  Because regeneration occurs at the end of the turn (after the combat phase) a ship that has been destroyed will not have it's shields regenerate.  This applies to the shield value only, the hull of a Federation ship does not regenerate.
   • Quantum torpedo: In addition to the standard phasers, Federation ships are armed with an unlimited number of quantum torpedoes.  The attack phase will now allow the player to fire two weapons.  At the beginning of this phase the game will first ask the row and column coordinates of the ship that the player wishes to target with the torpedo.  Assuming that these coordinates are valid  there is actually a ship in that sector, the bounds of the galaxy haven't been exceeded etc.) then the enemy ship at the location will be hit by the torpedo and it's shields will be totally disabled.   (The shield value will be set to zero if it was positive, there will be no effect if shields were already down).  This applies even when targeting a Borg cube (see the description of the Borg ship below).  After firing the torpedo, program will then allow the player to fire the phasers. Only one torpedo may be fired each turn and the player may pass on the firing of the torpedo in the same way that he or she may pass on the firing of the phasers.
   • Example: At the beginning of a turn we have a Federation star ship that is adjacent to two computer-controlled star ships (instances of the old StarShip class from the fourth assignment).

   	0	1
   0		C
   1	F	C
   2

    

   Computer-controlled ship at (0,1)
   Ship's system	Point value
   Shields	2150
   Hull	400

    

   Computer-controlled ship at (1,1)
   Ship's system	Point value
   Shields	4000
   Hull	400

   The person controlling the Federation ship chooses to fire the quantum torpedo at the first ship and enters (0, 1) for the (row, column) value.  Next comes the targeting of the phasers.  Although the player can (and probably should) attack the same ship he or she is not required to do so and in this example doesn't: 800 points of damage are inflicted on the shields of the second ship.  After this combat phase the computer-controlled ships end up at the following state:

   Computer-controlled ship at (0,1)
   Ship's system	Point value
   Shields	0 (down)
   Hull	400

    

   Computer-controlled ship at (1,1)
   Ship's system	Point value
   Shields	3200
   Hull	400

    

   A Sovereign class star ship.

   When debug mode is turned on the program should show the shield value of the targeted enemy before the torpedo was fired (point value before being hit by the torpedo) and the shield value after it was fired (it should now be zero).

3. Create a Jem'Hadar battleship. You are to implement a new class "JemHadarBattleship" that extends class StarShip.  This ship will replace one of the 3 computer-controlled star ships from the previous game.  The Jem'Hadar battleship has all the features of the basic star ship except:
   • It has an onscreen appearance of 'J'.
   • The Dominion uses a different type of phaser which consists of a charged beam of anti-protons. This weapon will inflict 200 to 800 points of damage per attack (possible values: 200, 300, 400, 500, 600, 700 or 800).  The beam can be fired once per attack phase.  Worse still (for the target) is that shields will have no effect against this type of energy weapon.  Regardless of the current shield value of the target, the anti-proton beam will directly reduce the hull value. The shield value of the ship will remain unchanged.

   A Jem'Hadar battleship.

   When the program is in debug mode it should show the amount of damage generated by the Jem'Hadar anti-proton beam, the shield and hull value of the player's ship before and after the attack.

4. Create a Klingon attack cruiser. You are to implement a new class "KlingonAttackCruiser" that extends class StarShip.  This ship will replace one of the 3 computer-controlled ships from the previous version of the game.  For example, if you already implemented the code for the Jem'Hadar battleship and the Borg cube then there will still be 3 computer-controlled ships: a Jem'Hadar battleship, a Borg cube and now the Klingon ship replaces the last instance of the old-style star ship from Assignment 4.   The Klingon attack cruiser has all the features of the basic star ship except:
   • All Klingon ships are equipped with an invisibility shield (called a "cloaking device") that not only bends visible light rays but also distorts the scanning devices of other ships.  The drawback is this device uses up so much energy that a ship cannot fire it's weapons while cloaked.  In terms of this game the cloaking device will provide the Klingon ship with the advantage of attacking before anybody else.  Thus the damage inflicted by the Klingon ship will be displayed before the player gets to attack.  The main implication is that the Klingon ship has the ability to destroy the player's star ship before the player can fire.  If this is the case then the game will display the damage inflicted and then it will end indicating that the player has lost.
   • The Klingon ship will not appear when the galaxy is displayed until the attack portion of each turn.   Instead a blank space is displayed in the grid.
   • During the attack phase the ship has an onscreen appearance of 'K'. After the attack phase is over the ship will cloak and disappear again (a blank space is displayed in that sector).
   • Klingon warships do not use phasers as their primary energy-based weapon but instead use disruptors that wreak havoc on the shields of the enemy.  The damage for Klingon disruptors is calculated in the same way that phaser damage is calculated  (ranges from 80 - 800).  However the damage deducted for disruptor fire on the shields is doubled.  Damage deducted from the hull value is normal.

   Example: The human player is controlling one of the standard star ships from the previous assignment and is taking on a Klingon attack cruiser.

   Human player's ship
   Ship's system	Point value
   Shields	600
   Hull	400

   The damage generated for the cruiser's disruptor fire is 700 points.  Because the disruptor fire has double the effect on shields, only 300 points of damage are required to cause the shields on the human player's ship to go down.  That leaves 400 points of disruptor energy left.  This damage is now deducted from the hull of the human player reducing it zero.  Because Klingon ships attack first the human player's ship is destroyed and the player has lost the game.  The results of the attack on the human player's ship is displayed and the game now ends with a status message indicating that the game was lost.  

   A Negh'var class attack cruiser de-cloaking for attack

   If the game is in cheat mode then the game should display: 1) The amount of disruptor damage generated 2) The amount deducted from the shields 3) The amount deducted from the hull (if any).

    

5. Create a Borg cube. You are to implement a new class "BorgCube" that extends class StarShip.  This ship will replace one of the 3 computer-controlled star ships from the game that you implemented for the fourth assignment.  For example, if you already implemented the code for the Jem'Hadar battleship there will still be 3 computer-controlled ships: a Jem'Hadar battleship, a Borg cube and an instance of one of the standard star ships from assignment 4.  The Borg cube has all the features of the basic star ship except:
   • It has an onscreen appearance of 'B'.
   • The cube is larger than the other ships in the game so it has double the hull and shield values of a regular star ship (800 points for the hull and 8000 for the shields).  However, the Borg ship in the game is represented by just one character just like the other ships. (For extra practice you might try having the Borg cube occupy 4 squares instead of 1).
   • Borg ships have the most advanced propulsion system in the game, called "transwarp".  Instead of having a maximum travel range of one sector like everyone else, Borg cubes can move up to 3 sectors per turn.   This means that when you are randomly generating the distance to be travel the change in the row or column value will be equal to 0, 1, 2 or up to 3 sectors.  (It can be quite a nasty jolt to have a Borg ship suddenly come along when you're already in the middle of a pitched battle with someone else).

   A Borg sphere ship travelling at transwarp (faster than warp) speed.

   • As Borg ships are attacked they are able to adapt the technology on their ship to reduce the effectiveness of the enemy's energy weapons so that successive hits will inflict less and less damage over time. 

   Attack number	Damage reduction to the cube
   First	No damage reduction
   Second	Damage is reduced by 25%
   Third	Damage is halved
   Fourth and successive attacks	Damage is reduced by 75%

   All fractional values are removed when determining damage.  For example, if 355 points of damage were randomly generated by a phaser hit on a Borg cube and this were the 4th attack then the damage inflicted would equal 88 points (355 / 4 = 88.75 which is reduced down to 88 points).

   Example: The human player is controlling one of the old star ships from the previous assignment (an instance of class StarShip).  The first time the player tangles with the Borg her phasers generate 800 points of damage.  All of this damage will be deducted from either the shields or hull of the cube depending on whether the shields are still up or not. The next turn the player fires on the cube again.  Her ship generates 800 points of damage.  A quarter of the energy is dissipated by the Borg's defensive systems (200 points) while the remaining 600 points are again deducted from the shields or hull of the cube.  The player fires a third time on the cube and the phasers generate 100 points of damage but now the cube absorbs only 50 points of damage, the other 50 points have been dissipated.  By now the player has had enough and flees the battle.  Should she try to tangle with the Borg again the phasers on her ship will do only a quarter damage to the Borg.

   Note however that the Borg ability to adapt only applies to energy based weapons like the phaser.  It will have no effect on either the quantum torpedo or the photonic cannon. 

   A Borg cube attacking a Federation task force

   When the program is in debug mode the program should show the full amount of damage generated by the player's phasers, the number of times that the Borg ship was hit by the player's ship and the damage that will actually be inflicted on the cube.

Finally you need to draw UML diagrams that show: 1) the classes from the previous version of the assignment 2) the new classes that you implemented for this assignment. Also you need to show the attributes and methods of each class as well as the relationship between classes.

Submitting your work:

1. Assignments (source code/'dot-java' files) must be electronically submitted according to [the assignment submission requirements]. As was the case with the third assignment, you are to submit your UML class diagram with your source code. You should zip all your Java source code files together, it's up to you if you wish to include the class diagram in this zip file or another.
2. As a reminder, you are not allowed to work in groups for this class. Copying the work of another student will be regarded as academic misconduct (cheating).  For additional details about what is and is not okay for this class please refer to the following [link].
3. Before you submit your assignment to help make sure that you haven't missed anything here is a [checklist] of items to be used in marking.

External libraries that can be used

1. Libraries that allow for text-based (console) input and output.
2. Libraries that will randomly generate numbers (e.g., class Random or class Math).

Some of the sources used to create this assignment

^{1 From Star Trek: The next generation, "The best of both worlds, Part II"}

^{Note: The use of the Star Trek © trademark was for educational purposes only and not meant as a copy write challenge.}