Fixed some little problems with documenting.

very small change -- again just for testing

.idea/misc.xml

@@ -1,9 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="JavadocGenerationManager">
+    <option name="OUTPUT_DIRECTORY" value="$USER_HOME$/Desktop/Javadocs TaipanClone" />
+    <option name="OPTION_HIERARCHY" value="false" />
+    <option name="OPTION_NAVIGATOR" value="false" />
+    <option name="OPTION_INDEX" value="false" />
+  </component>
   <component name="ProjectKey">
     <option name="state" value="project://63537948-39a4-48a0-9c97-34259a0fa913" />
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8.0_201" project-jdk-type="JavaSDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8.0_141" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
   <component name="SvnBranchConfigurationManager">

.idea/workspace.xml

@@ -1,48 +1,45 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="3114a2b9-4919-4fdf-8fd9-d03b60109ce4" name="Default Changelist" comment="Really small change in Sid's code that no one will probably ever notice lol">
+    <list default="true" id="3114a2b9-4919-4fdf-8fd9-d03b60109ce4" name="Default Changelist" comment="Fixed the commenting on a lot of the code. Also added some stuff to Travel, fixed some bugs.">
+      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/ShipWarfare.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/ShipWarfare.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/Travel.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/Travel.java" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/loanShark.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/loanShark.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main.java" afterDir="false" />
     </list>
     <ignored path="$PROJECT_DIR$/out/" />
+    <ignored path="C:\Users\Harkamal Randhawa\IdeaProjects\TaipanClone\.idea\shelf/" />
     <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
     <option name="LAST_RESOLUTION" value="IGNORE" />
   </component>
-  <component name="DatabaseView">
-    <option name="SHOW_INTERMEDIATE" value="true" />
-    <option name="GROUP_DATA_SOURCES" value="true" />
-    <option name="GROUP_SCHEMA" value="true" />
-    <option name="GROUP_CONTENTS" value="false" />
-    <option name="SORT_POSITIONED" value="false" />
-    <option name="SHOW_EMPTY_GROUPS" value="false" />
-    <option name="AUTO_SCROLL_FROM_SOURCE" value="false" />
-    <option name="HIDDEN_KINDS">
-      <set />
-    </option>
-    <expand />
-    <select />
-  </component>
   <component name="FileEditorManager">
-    <leaf>
+    <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
       <file pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/src/loanShark.java">
+        <entry file="file://$PROJECT_DIR$/src/Start.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="450">
+            <state relative-caret-position="590">
-              <caret line="30" column="21" lean-forward="true" selection-start-line="30" selection-start-column="21" selection-end-line="30" selection-end-column="21" />
+              <caret line="70" column="24" lean-forward="true" selection-start-line="70" selection-start-column="24" selection-end-line="70" selection-end-column="24" />
+            </state>
+          </provider>
+        </entry>
+      </file>
+      <file pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/src/main.java">
+          <provider selected="true" editor-type-id="text-editor">
+            <state relative-caret-position="184">
+              <caret line="42" column="62" selection-start-line="42" selection-start-column="62" selection-end-line="42" selection-end-column="62" />
             </state>
           </provider>
         </entry>
       </file>
       <file pinned="false" current-in-tab="true">
-        <entry file="file://$PROJECT_DIR$/src/ShipWarfare.java">
+        <entry file="file://$PROJECT_DIR$/src/Travel.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="234">
+            <state relative-caret-position="27">
-              <caret line="371" column="43" lean-forward="true" selection-start-line="371" selection-start-column="43" selection-end-line="371" selection-end-column="43" />
+              <caret line="125" column="63" selection-start-line="125" selection-start-column="63" selection-end-line="125" selection-end-column="63" />
               <folding>
                 <element signature="imports" expanded="true" />
               </folding>
@@ -51,19 +48,13 @@
         </entry>
       </file>
       <file pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/src/Travel.java">
+        <entry file="file://$PROJECT_DIR$/src/TaipanShop.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="136">
+            <state relative-caret-position="168">
-              <caret line="63" column="38" selection-start-line="63" selection-start-column="28" selection-end-line="63" selection-end-column="38" />
+              <caret line="594" column="42" lean-forward="true" selection-start-line="594" selection-start-column="42" selection-end-line="594" selection-end-column="42" />
-            </state>
+              <folding>
-          </provider>
+                <element signature="imports" expanded="true" />
-        </entry>
+              </folding>
-      </file>
-      <file pinned="false" current-in-tab="false">
-        <entry file="file://$PROJECT_DIR$/src/Start.java">
-          <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="353">
-              <caret line="33" column="9" lean-forward="true" selection-start-line="33" selection-start-column="9" selection-end-line="33" selection-end-column="9" />
             </state>
           </provider>
         </entry>
@@ -71,8 +62,26 @@
       <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/src/Bank.java">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="375">
+            <state relative-caret-position="-872">
-              <caret line="25" column="23" selection-start-line="25" selection-start-column="23" selection-end-line="25" selection-end-column="23" />
+              <caret line="7" column="6" lean-forward="true" selection-start-line="7" selection-start-column="6" selection-end-line="7" selection-end-column="6" />
+            </state>
+          </provider>
+        </entry>
+      </file>
+      <file pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/src/Player.java">
+          <provider selected="true" editor-type-id="text-editor">
+            <state relative-caret-position="-2606">
+              <caret line="24" column="5" lean-forward="true" selection-start-line="24" selection-start-column="5" selection-end-line="24" selection-end-column="5" />
+            </state>
+          </provider>
+        </entry>
+      </file>
+      <file pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/src/ShipWarfare.java">
+          <provider selected="true" editor-type-id="text-editor">
+            <state relative-caret-position="17">
+              <caret line="353" column="11" selection-start-line="353" selection-start-column="11" selection-end-line="353" selection-end-column="11" />
               <folding>
                 <element signature="imports" expanded="true" />
               </folding>
@@ -80,6 +89,15 @@
           </provider>
         </entry>
       </file>
+      <file pinned="false" current-in-tab="false">
+        <entry file="file://$PROJECT_DIR$/src/Warehouse.java">
+          <provider selected="true" editor-type-id="text-editor">
+            <state relative-caret-position="34">
+              <caret line="2" column="3" selection-start-line="2" selection-start-column="3" selection-end-line="2" selection-end-column="3" />
+            </state>
+          </provider>
+        </entry>
+      </file>
     </leaf>
   </component>
   <component name="FileTemplateManagerImpl">
@@ -91,85 +109,57 @@
   </component>
   <component name="FindInProjectRecents">
     <findStrings>
-      <find>howmuchRun</find>
+      <find>Hp</find>
-      <find>setPlayer</find>
+      <find>travel</find>
-      <find>setNumOf</find>
+      <find>notDone</find>
-      <find>setNumOfLitty</find>
+      <find>GetGuns</find>
-      <find>setNumOfLitt</find>
+      <find>get</find>
-      <find>setG</find>
-      <find>setMoney</find>
-      <find>setN</find>
-      <find>setNum</find>
-      <find>startingPeasantShips</find>
-      <find>startingLittyShips</find>
-      <find>destroy</find>
-      <find>litty</find>
-      <find>peasant</find>
-      <find>setmone</find>
       <find>set</find>
-      <find>player.</find>
+      <find>TaipanShop</find>
-      <find>System.out.println(&quot;\n*** PLACEHOLDER FOR LOAN SHARK ***\n&quot;);</find>
+      <find>shop()</find>
-      <find>keep</find>
+      <find>shop</find>
-      <find>showWa</find>
-      <find>player.get</find>
-      <find>throws Exception</find>
-      <find>would</find>
-      <find>.nextInt</find>
-      <find>getName</find>
-      <find>we made it</find>
-      <find>delayfora</find>
-      <find>dela</find>
-      <find>couldn</find>
-      <find>GUNS</find>
     </findStrings>
     <replaceStrings>
-      <replace>player.getName()</replace>
+      <replace>HP</replace>
-      <replace>player.getBank()</replace>
+      <replace>p1.get</replace>
-      <replace>player.setMoney(player.getMoney() + num*)</replace>
+      <replace>p1.set</replace>
-      <replace>player.getOpiumHeld()</replace>
-      <replace>numOfPeasantShips</replace>
-      <replace>typeOfShip</replace>
-      <replace>chanceOfRun</replace>
-      <replace>litty</replace>
-      <replace>Liitty</replace>
-      <replace>Litty</replace>
-      <replace>player.set</replace>
-      <replace>%s</replace>
-      <replace>loan();</replace>
-      <replace>throws InterruptedException</replace>
     </replaceStrings>
   </component>
   <component name="Git.Settings">
+    <option name="UPDATE_CHANGES_POLICY" value="SHELVE" />
+    <option name="UPDATE_TYPE" value="MERGE" />
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
   </component>
   <component name="IdeDocumentHistory">
     <option name="CHANGED_PATHS">
       <list>
-        <option value="$PROJECT_DIR$/src/Test.java" />
+        <option value="$PROJECT_DIR$/src/Core.java" />
-        <option value="$PROJECT_DIR$/src/Player.java" />
+        <option value="$PROJECT_DIR$/src/Game.java" />
-        <option value="$PROJECT_DIR$/src/Travel.java" />
-        <option value="$PROJECT_DIR$/src/main.java" />
-        <option value="$PROJECT_DIR$/src/TaipanShop.java" />
-        <option value="$PROJECT_DIR$/src/Start.java" />
-        <option value="$PROJECT_DIR$/src/Warehouse.java" />
-        <option value="$PROJECT_DIR$/src/Bank.java" />
-        <option value="$PROJECT_DIR$/src/loanShark.java" />
         <option value="$PROJECT_DIR$/src/ShipWarfare.java" />
+        <option value="$PROJECT_DIR$/src/Player.java" />
+        <option value="$PROJECT_DIR$/src/Start.java" />
+        <option value="$PROJECT_DIR$/src/TaipanShop.java" />
+        <option value="$PROJECT_DIR$/src/main.java" />
+        <option value="$PROJECT_DIR$/src/Travel.java" />
       </list>
     </option>
   </component>
   <component name="ProjectFrameBounds" extendedState="6">
-    <option name="y" value="23" />
+    <option name="x" value="167" />
-    <option name="width" value="1280" />
+    <option name="y" value="-11" />
-    <option name="height" value="709" />
+    <option name="width" value="1696" />
+    <option name="height" value="1026" />
+  </component>
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true">
+    <ConfirmationsSetting value="2" id="Add" />
   </component>
-  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
   <component name="ProjectView">
     <navigator proportions="" version="1">
       <foldersAlwaysOnTop value="true" />
     </navigator>
     <panes>
       <pane id="Scope" />
+      <pane id="PackagesPane" />
       <pane id="ProjectPane">
         <subPane>
           <expand>
@@ -186,19 +176,19 @@
           <select />
         </subPane>
       </pane>
-      <pane id="PackagesPane" />
     </panes>
   </component>
   <component name="PropertiesComponent">
+    <property name="ChangesTree.GroupingKeys" value="" />
     <property name="WebServerToolWindowFactoryState" value="false" />
     <property name="aspect.path.notification.shown" value="true" />
-    <property name="com.android.tools.idea.instantapp.provision.ProvisionBeforeRunTaskProvider.myTimeStamp" value="1551066288602" />
+    <property name="com.android.tools.idea.instantapp.provision.ProvisionBeforeRunTaskProvider.myTimeStamp" value="1551163322073" />
-    <property name="extract.method.default.visibility" value="public" />
+    <property name="extract.method.default.visibility" value="private" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
+    <property name="last_opened_file_path" value="$USER_HOME$/Documents/GitHub/Cpsc233" />
     <property name="project.structure.last.edited" value="Project" />
     <property name="project.structure.proportion" value="0.15" />
     <property name="project.structure.side.proportion" value="0.2" />
-    <property name="settings.editor.selected.configurable" value="preferences.keymap" />
+    <property name="settings.editor.selected.configurable" value="editing.templates" />
   </component>
   <component name="RunDashboard">
     <option name="ruleStates">
@@ -213,18 +203,8 @@
     </option>
   </component>
   <component name="RunManager" selected="Application.main">
-    <configuration name="Main" type="Application" factoryName="Application" temporary="true">
+    <configuration name="Game" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
-      <option name="MAIN_CLASS_NAME" value="Main" />
+      <option name="MAIN_CLASS_NAME" value="Game" />
-      <module name="TaipanClone" />
-      <option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
-      <RunnerSettings RunnerId="Run" />
-      <ConfigurationWrapper RunnerId="Run" />
-      <method v="2">
-        <option name="Make" enabled="true" />
-      </method>
-    </configuration>
-    <configuration name="Player" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
-      <option name="MAIN_CLASS_NAME" value="Player" />
       <module name="TaipanClone" />
       <method v="2">
         <option name="Make" enabled="true" />
@@ -237,8 +217,15 @@
         <option name="Make" enabled="true" />
       </method>
     </configuration>
-    <configuration name="Test" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
+    <configuration name="TaipanShop" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
-      <option name="MAIN_CLASS_NAME" value="Test" />
+      <option name="MAIN_CLASS_NAME" value="TaipanShop" />
+      <module name="TaipanClone" />
+      <method v="2">
+        <option name="Make" enabled="true" />
+      </method>
+    </configuration>
+    <configuration name="Travel" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
+      <option name="MAIN_CLASS_NAME" value="Travel" />
       <module name="TaipanClone" />
       <method v="2">
         <option name="Make" enabled="true" />
@@ -252,24 +239,24 @@
       </method>
     </configuration>
     <list>
-      <item itemvalue="Application.Main" />
-      <item itemvalue="Application.Player" />
       <item itemvalue="Application.ShipWarfare" />
-      <item itemvalue="Application.Test" />
+      <item itemvalue="Application.TaipanShop" />
+      <item itemvalue="Application.Travel" />
+      <item itemvalue="Application.Game" />
       <item itemvalue="Application.main" />
     </list>
     <recent_temporary>
       <list>
         <item itemvalue="Application.main" />
+        <item itemvalue="Application.TaipanShop" />
+        <item itemvalue="Application.Game" />
         <item itemvalue="Application.ShipWarfare" />
-        <item itemvalue="Application.Main" />
+        <item itemvalue="Application.Travel" />
-        <item itemvalue="Application.Test" />
-        <item itemvalue="Application.Player" />
       </list>
     </recent_temporary>
   </component>
   <component name="SvnConfiguration" cleanupOnStartRun="true">
-    <configuration>$USER_HOME$/.subversion</configuration>
+    <configuration>C:\Users\Harkamal Randhawa\AppData\Roaming\Subversion</configuration>
     <supportedVersion>125</supportedVersion>
   </component>
   <component name="TaskManager">
@@ -280,189 +267,104 @@
       <option name="presentableId" value="Default" />
       <updated>1550454898506</updated>
       <workItem from="1550454902781" duration="459000" />
-      <workItem from="1550550806467" duration="577000" />
+      <workItem from="1550458230268" duration="571000" />
-      <workItem from="1550552635138" duration="118000" />
+      <workItem from="1550459021117" duration="128000" />
-      <workItem from="1550553016386" duration="7671000" />
+      <workItem from="1550459458251" duration="1743000" />
-      <workItem from="1550672213804" duration="29657000" />
+      <workItem from="1550538713935" duration="16351000" />
-      <workItem from="1550872712636" duration="122000" />
+      <workItem from="1550614728336" duration="8160000" />
-      <workItem from="1550879399892" duration="1335000" />
+      <workItem from="1550704188250" duration="4948000" />
-      <workItem from="1550899071486" duration="108000" />
+      <workItem from="1550810552736" duration="1982000" />
-      <workItem from="1550954455279" duration="500000" />
+      <workItem from="1550878072546" duration="2009000" />
-      <workItem from="1551066469788" duration="198000" />
+      <workItem from="1551065104002" duration="1313000" />
-      <workItem from="1551066703607" duration="6918000" />
+      <workItem from="1551158469442" duration="4822000" />
     </task>
-    <task id="LOCAL-00001" summary="Added troll comments">
+    <task id="LOCAL-00001" summary="This should fix the ShipWarfare file and bring it up to date with the rest of the file.">
-      <created>1550458807806</created>
+      <created>1550458470138</created>
       <option name="number" value="00001" />
       <option name="presentableId" value="LOCAL-00001" />
       <option name="project" value="LOCAL" />
-      <updated>1550458807807</updated>
+      <updated>1550458470138</updated>
     </task>
-    <task id="LOCAL-00002" summary="the shop now uses the player class as a parent class.">
+    <task id="LOCAL-00002" summary="Created Core class">
-      <created>1550544462410</created>
+      <created>1550540282400</created>
       <option name="number" value="00002" />
       <option name="presentableId" value="LOCAL-00002" />
       <option name="project" value="LOCAL" />
-      <updated>1550544462410</updated>
+      <updated>1550540282400</updated>
     </task>
-    <task id="LOCAL-00003" summary="the shop now uses the player class as a parent class.">
+    <task id="LOCAL-00003" summary="Created Player class">
-      <created>1550544805794</created>
+      <created>1550540820542</created>
       <option name="number" value="00003" />
       <option name="presentableId" value="LOCAL-00003" />
       <option name="project" value="LOCAL" />
-      <updated>1550544805794</updated>
+      <updated>1550540820542</updated>
     </task>
-    <task id="LOCAL-00004" summary="Vikram, these are the types of changes Harkey and I meant for you to establish.">
+    <task id="LOCAL-00004" summary="Created Player class">
-      <created>1550554529721</created>
+      <created>1550541406597</created>
       <option name="number" value="00004" />
       <option name="presentableId" value="LOCAL-00004" />
       <option name="project" value="LOCAL" />
-      <updated>1550554529721</updated>
+      <updated>1550541406597</updated>
     </task>
-    <task id="LOCAL-00005" summary="Added GameOver() Method to Player class, btw System.out.flush just straight up Thanos's the terminal at the time (clears it).">
+    <task id="LOCAL-00005" summary="Fixed the setters to be greater than 0">
-      <created>1550555424630</created>
+      <created>1550541751914</created>
       <option name="number" value="00005" />
       <option name="presentableId" value="LOCAL-00005" />
       <option name="project" value="LOCAL" />
-      <updated>1550555424631</updated>
+      <updated>1550541751914</updated>
     </task>
-    <task id="LOCAL-00006" summary="I think I got the basic battling system down. Would appreciate i some of you guys beta tested it though and let me know the errors if there are any.">
+    <task id="LOCAL-00006" summary="Created Player class">
-      <created>1550673099893</created>
+      <created>1550543764970</created>
       <option name="number" value="00006" />
       <option name="presentableId" value="LOCAL-00006" />
       <option name="project" value="LOCAL" />
-      <updated>1550673099893</updated>
+      <updated>1550543764971</updated>
     </task>
-    <task id="LOCAL-00007" summary="Perhaps done basic ship warfare?">
+    <task id="LOCAL-00007" summary="Added some stuff for the Travel Class">
-      <created>1550674024950</created>
+      <created>1550575512841</created>
       <option name="number" value="00007" />
       <option name="presentableId" value="LOCAL-00007" />
       <option name="project" value="LOCAL" />
-      <updated>1550674024950</updated>
+      <updated>1550575512841</updated>
     </task>
-    <task id="LOCAL-00008" summary="Perhaps done basic ship warfare? (still must add Liu yen difficulty, ships running away, and Loot)">
+    <task id="LOCAL-00008" summary="Added disasters as well as removing a bug from the flee method in Haris's code">
-      <created>1550681271530</created>
+      <created>1550623749854</created>
       <option name="number" value="00008" />
       <option name="presentableId" value="LOCAL-00008" />
       <option name="project" value="LOCAL" />
-      <updated>1550681271530</updated>
+      <updated>1550623749854</updated>
     </task>
-    <task id="LOCAL-00009" summary="Perhaps done basic ship warfare? (still must add Liu yen difficulty, ships running away, and Loot)">
+    <task id="LOCAL-00009" summary="Fixed a bunch of stuff inside of Travel, but also discovered a MASSIVE problem with our code">
-      <created>1550704064692</created>
+      <created>1550628232136</created>
       <option name="number" value="00009" />
       <option name="presentableId" value="LOCAL-00009" />
       <option name="project" value="LOCAL" />
-      <updated>1550704064692</updated>
+      <updated>1550628232136</updated>
     </task>
-    <task id="LOCAL-00010" summary="Added loot. Still need to have ships escape sometimes and Liu yen">
+    <task id="LOCAL-00010" summary="Brought back Vikram's changes">
-      <created>1550810365166</created>
+      <created>1550879092914</created>
       <option name="number" value="00010" />
       <option name="presentableId" value="LOCAL-00010" />
       <option name="project" value="LOCAL" />
-      <updated>1550810365166</updated>
+      <updated>1550879092914</updated>
     </task>
-    <task id="LOCAL-00011" summary="Sloppy but completed ShipWarfare class">
+    <task id="LOCAL-00011" summary="Fixed the commenting on a lot of the code. Also added some stuff to Travel, fixed some bugs.">
-      <created>1550817871034</created>
+      <created>1551162699319</created>
       <option name="number" value="00011" />
       <option name="presentableId" value="LOCAL-00011" />
       <option name="project" value="LOCAL" />
-      <updated>1550817871034</updated>
+      <updated>1551162699319</updated>
     </task>
-    <task id="LOCAL-00012" summary="Fixed like 3 naming/logical errors in ShipWarfare">
+    <option name="localTasksCounter" value="12" />
-      <created>1550820057346</created>
-      <option name="number" value="00012" />
-      <option name="presentableId" value="LOCAL-00012" />
-      <option name="project" value="LOCAL" />
-      <updated>1550820057346</updated>
-    </task>
-    <task id="LOCAL-00013" summary="Added a few comments to ShipWarfare">
-      <created>1550954954057</created>
-      <option name="number" value="00013" />
-      <option name="presentableId" value="LOCAL-00013" />
-      <option name="project" value="LOCAL" />
-      <updated>1550954954057</updated>
-    </task>
-    <task id="LOCAL-00014" summary="bunch of revisions, still in progress">
-      <created>1551049097974</created>
-      <option name="number" value="00014" />
-      <option name="presentableId" value="LOCAL-00014" />
-      <option name="project" value="LOCAL" />
-      <updated>1551049097974</updated>
-    </task>
-    <task id="LOCAL-00015" summary="bunch of revisions, still in progress">
-      <created>1551052425343</created>
-      <option name="number" value="00015" />
-      <option name="presentableId" value="LOCAL-00015" />
-      <option name="project" value="LOCAL" />
-      <updated>1551052425343</updated>
-    </task>
-    <task id="LOCAL-00016" summary="bunch of revisions, still in progress">
-      <created>1551052501350</created>
-      <option name="number" value="00016" />
-      <option name="presentableId" value="LOCAL-00016" />
-      <option name="project" value="LOCAL" />
-      <updated>1551052501350</updated>
-    </task>
-    <task id="LOCAL-00017" summary="bunch of revisions, still in progress">
-      <created>1551060038524</created>
-      <option name="number" value="00017" />
-      <option name="presentableId" value="LOCAL-00017" />
-      <option name="project" value="LOCAL" />
-      <updated>1551060038524</updated>
-    </task>
-    <task id="LOCAL-00018" summary="Worked On Sid's class a bit">
-      <created>1551063376717</created>
-      <option name="number" value="00018" />
-      <option name="presentableId" value="LOCAL-00018" />
-      <option name="project" value="LOCAL" />
-      <updated>1551063376717</updated>
-    </task>
-    <task id="LOCAL-00019" summary="Think I fixed Sid's code">
-      <created>1551065166040</created>
-      <option name="number" value="00019" />
-      <option name="presentableId" value="LOCAL-00019" />
-      <option name="project" value="LOCAL" />
-      <updated>1551065166040</updated>
-    </task>
-    <task id="LOCAL-00020" summary="Small thing, changed an output of warehouse a bit, shows user its the warehosue they are concerned with.">
-      <created>1551065447444</created>
-      <option name="number" value="00020" />
-      <option name="presentableId" value="LOCAL-00020" />
-      <option name="project" value="LOCAL" />
-      <updated>1551065447444</updated>
-    </task>
-    <task id="LOCAL-00021" summary="Forgot a try catch in warehouse">
-      <created>1551065880809</created>
-      <option name="number" value="00021" />
-      <option name="presentableId" value="LOCAL-00021" />
-      <option name="project" value="LOCAL" />
-      <updated>1551065880809</updated>
-    </task>
-    <task id="LOCAL-00022" summary="Sneaky bug in shipWarfare regarding having 0 guns is now fixed.">
-      <created>1551069200511</created>
-      <option name="number" value="00022" />
-      <option name="presentableId" value="LOCAL-00022" />
-      <option name="project" value="LOCAL" />
-      <updated>1551069200512</updated>
-    </task>
-    <task id="LOCAL-00023" summary="Really small change in Sid's code that no one will probably ever notice lol">
-      <created>1551069620616</created>
-      <option name="number" value="00023" />
-      <option name="presentableId" value="LOCAL-00023" />
-      <option name="project" value="LOCAL" />
-      <updated>1551069620616</updated>
-    </task>
-    <option name="localTasksCounter" value="24" />
     <servers />
   </component>
   <component name="TimeTrackingManager">
-    <option name="totallyTimeSpent" value="53362000" />
+    <option name="totallyTimeSpent" value="42486000" />
   </component>
   <component name="ToolWindowManager">
-    <frame x="0" y="23" width="1280" height="709" extended-state="6" />
+    <frame x="-8" y="-8" width="1696" height="1026" extended-state="7" />
-    <editor active="true" />
     <layout>
-      <window_info content_ui="combo" id="Project" order="0" visible="true" weight="0.31987077" />
+      <window_info content_ui="combo" id="Project" order="0" visible="true" weight="0.21026894" />
       <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
       <window_info id="Image Layers" order="2" />
       <window_info id="Designer" order="3" />
@@ -470,130 +372,191 @@
       <window_info id="Capture Tool" order="5" />
       <window_info id="Favorites" order="6" side_tool="true" />
       <window_info anchor="bottom" id="Message" order="0" />
-      <window_info anchor="bottom" id="Find" order="1" />
+      <window_info anchor="bottom" id="Find" order="1" weight="0.32922733" />
-      <window_info anchor="bottom" id="Run" order="2" sideWeight="0.4983845" weight="0.3241491" />
+      <window_info active="true" anchor="bottom" id="Run" order="2" visible="true" weight="0.3975364" />
       <window_info anchor="bottom" id="Debug" order="3" weight="0.4" />
       <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
       <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
       <window_info anchor="bottom" id="TODO" order="6" />
       <window_info anchor="bottom" id="Docker" order="7" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Version Control" order="8" sideWeight="0.49946696" weight="0.32901135" />
+      <window_info anchor="bottom" id="Version Control" order="8" sideWeight="0.49938875" weight="0.32922733" />
       <window_info anchor="bottom" id="Database Changes" order="9" />
-      <window_info anchor="bottom" id="Terminal" order="10" weight="0.32936078" />
+      <window_info anchor="bottom" id="Terminal" order="10" weight="0.32922733" />
-      <window_info anchor="bottom" id="Event Log" order="11" sideWeight="0.5016155" side_tool="true" weight="0.3241491" />
+      <window_info anchor="bottom" id="Event Log" order="11" sideWeight="0.50061125" side_tool="true" weight="0.32922733" />
-      <window_info anchor="bottom" id="Messages" order="12" weight="0.048622366" />
+      <window_info anchor="bottom" id="Messages" order="12" sideWeight="0.49938875" weight="0.32922733" />
-      <window_info anchor="bottom" id="Duplicate detector" order="13" weight="0.32901135" />
+      <window_info anchor="bottom" id="Duplicate detector" order="13" weight="0.32922733" />
       <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
       <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
       <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
       <window_info anchor="right" id="Palette" order="3" />
-      <window_info anchor="right" id="Database" order="4" weight="0.32956383" />
+      <window_info anchor="right" id="Database" order="4" />
       <window_info anchor="right" id="Theme Preview" order="5" />
       <window_info anchor="right" id="Maven" order="6" />
       <window_info anchor="right" id="Capture Analysis" order="7" />
       <window_info anchor="right" id="Palette&#9;" order="8" />
     </layout>
+    <layout-to-restore>
+      <window_info active="true" content_ui="combo" id="Project" order="0" visible="true" weight="0.21026894" />
+      <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
+      <window_info id="Image Layers" order="2" />
+      <window_info id="Designer" order="3" />
+      <window_info id="UI Designer" order="4" />
+      <window_info id="Capture Tool" order="5" />
+      <window_info id="Favorites" order="6" side_tool="true" />
+      <window_info anchor="bottom" id="Message" order="0" />
+      <window_info anchor="bottom" id="Find" order="1" weight="0.32922733" />
+      <window_info anchor="bottom" id="Run" order="2" weight="0.3975364" />
+      <window_info anchor="bottom" id="Debug" order="3" weight="0.4" />
+      <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
+      <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
+      <window_info anchor="bottom" id="TODO" order="6" />
+      <window_info anchor="bottom" id="Docker" order="7" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Version Control" order="8" sideWeight="0.49938875" weight="0.32922733" />
+      <window_info anchor="bottom" id="Database Changes" order="9" />
+      <window_info anchor="bottom" id="Terminal" order="10" weight="0.32922733" />
+      <window_info anchor="bottom" id="Event Log" order="11" sideWeight="0.50061125" side_tool="true" weight="0.32922733" />
+      <window_info anchor="bottom" id="Messages" order="12" sideWeight="0.49938875" weight="0.32922733" />
+      <window_info anchor="bottom" id="Duplicate detector" order="13" weight="0.32922733" />
+      <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
+      <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
+      <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
+      <window_info anchor="right" id="Palette" order="3" />
+      <window_info anchor="right" id="Database" order="4" />
+      <window_info anchor="right" id="Theme Preview" order="5" />
+      <window_info anchor="right" id="Maven" order="6" />
+      <window_info anchor="right" id="Capture Analysis" order="7" />
+      <window_info anchor="right" id="Palette&#9;" order="8" />
+    </layout-to-restore>
   </component>
   <component name="TypeScriptGeneratedFilesManager">
     <option name="version" value="1" />
   </component>
+  <component name="Vcs.Log.History.Properties">
+    <option name="COLUMN_ORDER">
+      <list>
+        <option value="0" />
+        <option value="2" />
+        <option value="3" />
+        <option value="1" />
+      </list>
+    </option>
+  </component>
   <component name="VcsManagerConfiguration">
     <ignored-roots>
       <path value="$PROJECT_DIR$" />
     </ignored-roots>
     <MESSAGE value="This should fix the project repository once and for all." />
-    <MESSAGE value="Added troll comments" />
+    <MESSAGE value="This should fix the ShipWarfare file and bring it up to date with the rest of the file." />
-    <MESSAGE value="the shop now uses the player class as a parent class." />
+    <MESSAGE value="Created Core class" />
-    <MESSAGE value="Vikram, these are the types of changes Harkey and I meant for you to establish." />
+    <MESSAGE value="Fixed the setters to be greater than 0" />
-    <MESSAGE value="Added GameOver() Method to Player class, btw System.out.flush just straight up Thanos's the terminal at the time (clears it)." />
+    <MESSAGE value="Created Player class" />
-    <MESSAGE value="I think I got the basic battling system down. Would appreciate i some of you guys beta tested it though and let me know the errors if there are any." />
+    <MESSAGE value="Added some stuff for the Travel Class" />
-    <MESSAGE value="Perhaps done basic ship warfare?" />
+    <MESSAGE value="Added disasters as well as removing a bug from the flee method in Haris's code" />
-    <MESSAGE value="Perhaps done basic ship warfare? (still must add Liu yen difficulty, ships running away, and Loot)" />
+    <MESSAGE value="Fixed a bunch of stuff inside of Travel, but also discovered a MASSIVE problem with our code" />
-    <MESSAGE value="Added loot. Still need to have ships escape sometimes and Liu yen" />
+    <MESSAGE value="Fixed stupid problem where you can't access methods above yours" />
-    <MESSAGE value="Sloppy but completed ShipWarfare class" />
+    <MESSAGE value="Brought back Vikram's changes" />
-    <MESSAGE value="Fixed like 3 naming/logical errors in ShipWarfare" />
+    <MESSAGE value="Fixed the commenting on a lot of the code. Also added some stuff to Travel, fixed some bugs." />
-    <MESSAGE value="Added a few comments to ShipWarfare" />
+    <option name="LAST_COMMIT_MESSAGE" value="Fixed the commenting on a lot of the code. Also added some stuff to Travel, fixed some bugs." />
-    <MESSAGE value="bunch of revisions, still in progress" />
-    <MESSAGE value="linked all the classes together. The project is functional." />
-    <MESSAGE value="Worked On Sid's class a bit" />
-    <MESSAGE value="Think I fixed Sid's code" />
-    <MESSAGE value="Small thing, changed an output of warehouse a bit, shows user its the warehosue they are concerned with." />
-    <MESSAGE value="Forgot a try catch in warehouse" />
-    <MESSAGE value="Sneaky bug in shipWarfare regarding having 0 guns is now fixed." />
-    <MESSAGE value="Really small change in Sid's code that no one will probably ever notice lol" />
-    <option name="LAST_COMMIT_MESSAGE" value="Really small change in Sid's code that no one will probably ever notice lol" />
   </component>
   <component name="editorHistoryManager">
-    <entry file="file://$PROJECT_DIR$/TaipanClone.iml">
+    <entry file="uml://JAVA/ShipWarfare">
-      <provider selected="true" editor-type-id="text-editor" />
+      <provider selected="true" editor-type-id="UmlEditorProvider">
-    </entry>
+        <state>
-    <entry file="file://$PROJECT_DIR$/.idea/misc.xml">
+          <ID>JAVA</ID>
-      <provider selected="true" editor-type-id="text-editor" />
+          <OriginalElement>ShipWarfare</OriginalElement>
-    </entry>
+          <nodes>
-    <entry file="file://$PROJECT_DIR$/src/Test.java" />
+            <node x="" y="">ShipWarfare</node>
-    <entry file="file://$PROJECT_DIR$/src/Player.java">
+            <node x="" y="">Player</node>
-      <provider selected="true" editor-type-id="text-editor">
+          </nodes>
-        <state relative-caret-position="540">
+          <notes />
-          <caret line="150" column="4" selection-start-line="150" selection-start-column="4" selection-end-line="150" selection-end-column="4" />
+          <edges />
+          <settings layout="Hierarchic Group" zoom="1.0" x="213.0" y="195.0" />
+          <SelectedNodes />
+          <Categories />
+          <SCOPE>Project Files</SCOPE>
+          <VISIBILITY>private</VISIBILITY>
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/src/main.java">
+    <entry file="uml://JAVA/TaipanShop">
+      <provider selected="true" editor-type-id="UmlEditorProvider">
+        <state>
+          <ID>JAVA</ID>
+          <OriginalElement>TaipanShop</OriginalElement>
+          <nodes>
+            <node x="" y="">TaipanShop</node>
+            <node x="" y="">Player</node>
+          </nodes>
+          <notes />
+          <edges />
+          <settings layout="Hierarchic Group" zoom="1.0" x="56.0" y="54.0" />
+          <SelectedNodes />
+          <Categories />
+          <SCOPE>All</SCOPE>
+          <VISIBILITY>private</VISIBILITY>
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/src/Game.java" />
+    <entry file="file://$PROJECT_DIR$/src/Warehouse.java">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="375">
+        <state relative-caret-position="34">
-          <caret line="25" lean-forward="true" selection-start-line="25" selection-end-line="25" />
+          <caret line="2" column="3" selection-start-line="2" selection-start-column="3" selection-end-line="2" selection-end-column="3" />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/src/Start.java">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="590">
+          <caret line="70" column="24" lean-forward="true" selection-start-line="70" selection-start-column="24" selection-end-line="70" selection-end-column="24" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/src/Bank.java">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="375">
+        <state relative-caret-position="-872">
-          <caret line="25" column="23" selection-start-line="25" selection-start-column="23" selection-end-line="25" selection-end-column="23" />
+          <caret line="7" column="6" lean-forward="true" selection-start-line="7" selection-start-column="6" selection-end-line="7" selection-end-column="6" />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/src/ShipWarfare.java">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="17">
+          <caret line="353" column="11" selection-start-line="353" selection-start-column="11" selection-end-line="353" selection-end-column="11" />
           <folding>
             <element signature="imports" expanded="true" />
           </folding>
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/src/Warehouse.java">
+    <entry file="file://$PROJECT_DIR$/src/Player.java">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="2790">
+        <state relative-caret-position="-2606">
-          <caret line="186" column="13" selection-start-line="186" selection-start-column="13" selection-end-line="186" selection-end-column="13" />
+          <caret line="24" column="5" lean-forward="true" selection-start-line="24" selection-start-column="5" selection-end-line="24" selection-end-column="5" />
-        </state>
-      </provider>
-    </entry>
-    <entry file="file://$PROJECT_DIR$/src/Start.java">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="353">
-          <caret line="33" column="9" lean-forward="true" selection-start-line="33" selection-start-column="9" selection-end-line="33" selection-end-column="9" />
-        </state>
-      </provider>
-    </entry>
-    <entry file="file://$PROJECT_DIR$/src/loanShark.java">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="450">
-          <caret line="30" column="21" lean-forward="true" selection-start-line="30" selection-start-column="21" selection-end-line="30" selection-end-column="21" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/src/TaipanShop.java">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="1710">
+        <state relative-caret-position="168">
-          <caret line="610" column="27" lean-forward="true" selection-start-line="610" selection-start-column="27" selection-end-line="610" selection-end-column="27" />
+          <caret line="594" column="42" lean-forward="true" selection-start-line="594" selection-start-column="42" selection-end-line="594" selection-end-column="42" />
+          <folding>
+            <element signature="imports" expanded="true" />
+          </folding>
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/src/main.java">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="184">
+          <caret line="42" column="62" selection-start-line="42" selection-start-column="62" selection-end-line="42" selection-end-column="62" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/src/Travel.java">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="136">
+        <state relative-caret-position="27">
-          <caret line="63" column="38" selection-start-line="63" selection-start-column="28" selection-end-line="63" selection-end-column="38" />
+          <caret line="125" column="63" selection-start-line="125" selection-start-column="63" selection-end-line="125" selection-end-column="63" />
-        </state>
-      </provider>
-    </entry>
-    <entry file="file://$PROJECT_DIR$/src/ShipWarfare.java">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="234">
-          <caret line="371" column="43" lean-forward="true" selection-start-line="371" selection-start-column="43" selection-end-line="371" selection-end-column="43" />
           <folding>
             <element signature="imports" expanded="true" />
           </folding>
@@ -640,7 +603,7 @@
       </state>
       <state key="JdkListConfigurable.UI">
         <settings>
-          <last-edited>1.8.0_201</last-edited>
+          <last-edited>1.8</last-edited>
           <splitter-proportions>
             <option name="proportions">
               <list>
@@ -657,6 +620,7 @@
             <option name="proportions">
               <list>
                 <option value="0.2" />
+                <option value="0.6" />
               </list>
             </option>
           </splitter-proportions>
@@ -673,6 +637,17 @@
           </splitter-proportions>
         </settings>
       </state>
+      <state key="ScopeChooserConfigurable.UI">
+        <settings>
+          <splitter-proportions>
+            <option name="proportions">
+              <list>
+                <option value="0.2" />
+              </list>
+            </option>
+          </splitter-proportions>
+        </settings>
+      </state>
     </states>
   </component>
 </project>

src/Bank.java

@@ -1,36 +1,62 @@
-import java.sql.SQLOutput;
 import java.util.Scanner;
 
 public class Bank{
-	
+	private Player player;
-	 private Player player;
+
+	/**
+	 * setter method that takes in a Player object as an argument.
+	 *
+	 * @param player object of the class Player
+	 */
+
 	 public void setPlayer(Player player) {
 	        Player playerDummy = new Player(player);
 	        this.player = playerDummy;
 	 }
 
-	 public Player getPlayer(){
+	/**
+	 * getter method for obtaining a player object.
+	 *
+	 * @return returns player object
+	 */
+
+	public Player getPlayer(){
 	 	Player playerDummy = new Player(player);
 	 	return playerDummy;
 	 }
+	/**
+	 * Class Constructor that takes in a type player as a parameter
+	 *
+	 * @param player object of the class Player
+	 */
 
 	 public Bank(Player player){
 	 	Player playerDummy = new Player(player);
 	 	this.player = playerDummy;
 	 }
 
-	 public void bank(){
+	/**
+	 * This method is used to withdraw or deposit money into the bank account
+	 * by prompting the user if they would like to withdraw or deposit. Followed
+	 * by prompting them to enter an amount to transfer. This method also uses the
+	 * player class to see if the transfer can be made,and if it can it changes the
+	 * values accordingly
+	 */
+	public void bank(){
 	 	Scanner input = new Scanner(System.in);
 	 	boolean notDone = true;
 	 	 int check = 0;
 	 	while(notDone){
+	 		//Prompt the user if they want to withdraw or deposit
 			System.out.println("Would you like to Withdraw or Deposit?");
 			String response = input.nextLine();
+			//If user chose withdraw then subtract the amount from bank account and add it to cash
 			if(response.equalsIgnoreCase("W")){
 				boolean notDone2 = true;
 				while(notDone2){
 					System.out.println("How much do you wish to Withdraw?");
 					int withdraw = input.nextInt();
+					//Prompt the user for the amount and check if the bank has sufficient funds
 					if(withdraw <= player.getBank()){
 						player.setMoney(withdraw + player.getMoney());
 						player.setBank(player.getBank()-withdraw);
@@ -38,9 +64,13 @@ public class Bank{
 						check = 1;
 					}
 				}
-			}else if(response.equalsIgnoreCase("D")){
+
+			}
+			//If the user chooses to deposit the continue to this code
+			else if(response.equalsIgnoreCase("D")){
 				boolean notDone2 = true;
 				while(notDone2){
+					//Prompt the user for the amount they would like to deposit and ensure suffiecent funds
 					System.out.println("How much do you wish to Deposit?");
 					int deposit = input.nextInt();
 					if(deposit <= player.getMoney()){
@@ -53,6 +83,7 @@ public class Bank{
 			}
 			if(check == 1){
 				boolean notDone3 = true;
+				// Asks user if they would like to continue in bank or not
 				while(notDone3){
 					System.out.println("Would you like to continue? Y/N");
 					response = input.nextLine();

src/Player.java

@@ -1,3 +1,5 @@
+import java.util.Scanner;
+
 public class Player {
 
     private String name = "Taipan";
@@ -16,11 +18,17 @@ public class Player {
     private int wGeneral = 0;
     private int wArms = 0;
     private boolean retire = false;
+    private int cargoSpace = 60;
 
     public Player(){
 
     }
 
+    /**
+    * Copy constructor
+    *
+    * @param player object of the class Player
+    */
     public Player(Player player){
         this.bank = player.bank;
         this.money = player.money;
@@ -36,80 +44,196 @@ public class Player {
         this.wSilk = player.wSilk;
         this.wGeneral = player.wGeneral;
         this.wArms = player.wArms;
-
     }
 
+    /**
+    * getter method for the instance variable cargoSpace.
+    *
+    * @return returns the instance variable cargoSpace
+    */
+    
+    public int getCargoSpace() {
+        return cargoSpace;
+    }
+
+    /**
+    * setter method for the instance variable cargoSpace.
+    *
+    * @param cargoSpace takes an int that is greater than 0 as an argument
+    */
+    
+    public void setCargoSpace(int cargoSpace) {
+        if(cargoSpace > 0){
+            this.cargoSpace = cargoSpace;
+        }
+    }
+
+    /**
+    * getter method for the instance variable retire.
+    *
+    * @return returns the instance variable retire
+    */
+    
     public boolean getRetire(){
         return retire;
     }
 
+    /**
+    * setter method for the instance variable retire.
+    *
+    * @param retire takes a boolean as an argument
+    */
+    
     public void setRetire(boolean retire){
         if(retire){
             this.retire = retire;
         }
     }
-
+    
+    /**
+    * getter method for the instance variable name.
+    *
+    * @return returns the instance variable name
+    */
+    
     public String getName() {
         return name;
     }
+    
+    /**
+    * setter method for the instance variable name.
+    *
+    * @param name takes a string as an argument
+    */
 
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+    * getter method for the instance variable HP.
+    *
+    * @return returns the instance variable HP
+    */
+    
     public int getHP() {
         return HP;
     }
+    
+    /**
+    * setter method for the instance variable HP.
+    *
+    * @param HP takes an int as an argument
+    */
 
     public void setHP(int HP) {
 
         this.HP = HP;
-
     }
 
+    /**
+    * getter method for the instance variable bank.
+    *
+    * @return returns the instance variable bank
+    */
+    
     public int getBank() {
         return bank;
     }
 
+    /**
+    * setter method for the instance variable bank.
+    *
+    * @param bank takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setBank(int bank) {
         if (bank >= 0) {
             this.bank = bank;
         }
     }
 
+    /**
+    * getter method for the instance variable money.
+    *
+    * @return returns the instance variable money
+    */
+    
     public int getMoney() {
         return money;
     }
 
+    /**
+    * setter method for the instance variable money.
+    *
+    * @param money takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setMoney(int money) {
         if (money >= 0) {
             this.money = money;
         }
     }
 
+    /**
+    * getter method for the instance variable opiumHeld.
+    *
+    * @return returns the instance variable opiumHeld
+    */
+    
     public int getOpiumHeld() {
         return opiumHeld;
     }
 
+    /**
+    * setter method for the instance variable opiumHeld.
+    *
+    * @param opiumHeld takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setOpiumHeld(int opiumHeld) {
         if (opiumHeld >= 0) {
             this.opiumHeld = opiumHeld;
         }
     }
 
+    /**
+    * getter method for the instance variable silkHeld.
+    *
+    * @return returns the instance variable silkHeld
+    */
+    
     public int getSilkHeld() {
         return silkHeld;
     }
 
+    /**
+    * setter method for the instance variable silkHeld.
+    *
+    * @param silkHeld takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setSilkHeld(int silkHeld) {
         if (silkHeld >= 0) {
             this.silkHeld = silkHeld;
         }
     }
+    
+    /**
+    * getter method for the instance variable generalHeld.
+    *
+    * @return returns the instance variable generalHeld
+    */
 
     public int getGeneralHeld() {
         return generalHeld;
     }
+    
+    /**
+    * setter method for the instance variable generalHeld.
+    *
+    * @param generalHeld takes an int that is greater than or equal to 0 as an argument
+    */
 
     public void setGeneralHeld(int generalHeld) {
         if (generalHeld >= 0) {
@@ -117,81 +241,192 @@ public class Player {
         }
     }
 
+    /**
+    * getter method for the instance variable armsHeld.
+    *
+    * @return returns the instance variable armsHeld
+    */
+    
     public int getArmsHeld() {
         return armsHeld;
     }
 
+    /**
+    * setter method for the instance variable armsHeld.
+    *
+    * @param armsHeld takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setArmsHeld(int armsHeld) {
         if (armsHeld >= 0) {
             this.armsHeld = armsHeld;
         }
     }
 
+    /**
+    * getter method for the instance variable location.
+    *
+    * @return returns the instance variable location
+    */
+    
     public int getLocation() {
         return location;
     }
 
+    /**
+    * setter method for the instance variable location.
+    *
+    * @param location takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setLocation(int location) {
         if (location >= 0) {
             this.location = location;
         }
     }
 
+    /**
+    * getter method for the instance variable guns.
+    *
+    * @return returns the instance variable guns
+    */
+    
     public int getGuns() {
         return guns;
     }
 
+    /**
+    * setter method for the instance variable guns.
+    *
+    * @param guns takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setGuns(int guns) {
         if (guns >= 0) {
             this.guns = guns;
         }
         
     }
+    
+    /**
+    * getter method for the instance variable debt.
+    *
+    * @return returns the instance variable debt
+    */
+    
     public int getDebt() {
         return debt;
     }
-        
+    
+    /**
+    * setter method for the instance variable debt.
+    *
+    * @param debt takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setDebt(int debt) {
         if (debt >= 0) {
             this.debt = debt;
         }
     }
 
-    public int getwOpium(){ return wOpium; }
+    /**
+    * getter method for the instance variable wOpium.
+    *
+    * @return returns the instance variable wOpium
+    */
+    
+    public int getwOpium() {
+        return wOpium; 
+    }
 
+    /**
+    * setter method for the instance variable wOpium.
+    *
+    * @param wOpium takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setwOpium(int wOpium) {
         if (wOpium >= 0){
             this.wOpium = wOpium;
         }
     }
 
-    public int getwSilk(){return wSilk;}
+    /**
+    * getter method for the instance variable wSilk.
+    *
+    * @return returns the instance variable wSilk
+    */
+    
+    public int getwSilk() {
+        return wSilk;
+    }
 
+    /**
+    * setter method for the instance variable wSilk.
+    *
+    * @param wSilk takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setwSilk(int wSilk) {
         if (wSilk >= 0){
             this.wSilk = wSilk;
         }
     }
 
-    public int getwGeneral(){return wGeneral;}
+    /**
+    * getter method for the instance variable wGeneral.
+    *
+    * @return returns the instance variable wGeneral
+    */
+    
+    public int getwGeneral() {
+        return wGeneral;
+    }
 
+    /**
+    * setter method for the instance variable wGeneral.
+    *
+    * @param wGeneral takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setwGeneral(int wGeneral) {
         if (wGeneral >= 0){
             this.wGeneral = wGeneral;
         }
     }
 
-    public int getwArms(){return wArms;}
+    /**
+    * getter method for the instance variable wArms.
+    *
+    * @return returns the instance variable wArms
+    */
+    
+    public int getwArms() {
+        return wArms;
+    }
 
+    /**
+    * setter method for the instance variable wArms.
+    *
+    * @param wArms takes an int that is greater than or equal to 0 as an argument
+    */
+    
     public void setwArms(int wArms) {
         if (wArms >= 0){
             this.wArms = wArms;
         }
     }
 
+    /**
+     * Method to indicate that you have lost the game. If the player has lost, console will be cleared and will only
+     * show the statement "Game Over". After showing the message the game closes.
+     *
+     **/
+    
     public void gameOver(){
         System.out.flush();
         System.out.println("Game over");
+        System.exit(0);
     }
-
+}
-}

src/ShipWarfare.java

@@ -2,33 +2,49 @@ import java.util.Scanner;
 import java.util.Random;
 import java.util.concurrent.TimeUnit;
 
+
 public class ShipWarfare {
 
     private int numOfPeasantShips = 0;
     private int numOfLittyShips = 0;
     private boolean userAttacks = true;
     private int startingPeasantShips = 0;
-    private int startingLittyShips =0;
+    private int startingLittyShips = 0;
     private int howMuchRun = 0;
     private String pirateName = "Liu Yen";
     private Player player;
 
-    public ShipWarfare(Player player){
+    /**
+     * Class Constructor that takes in a type player as a parameter
+     * @param player object of the class Player
+     */
+    public ShipWarfare(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
+    /**
+     * setter method for player
+     * @param player object of the class Player
+     */
     public void setPlayer(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
-    public Player getPlayer(){
+    /**
+     * getter method for obtaining a player object.
+     * @return returns player object
+     */
+    public Player getPlayer() {
         Player playerDummy = new Player(player);
         return playerDummy;
     }
-    
+
-    //This fleet is easy to defeat as a maximum of 15 ships can run away each volley, they can not tank hits
+    /**
+     * This fleet is easy to defeat as a maximum of 15 ships can run away each volley, they can not tank hits
+     * @throws Exception in case of errors due to the delay
+     */
     public void peasantFleetAttack() throws Exception {
         Scanner userResponse = new Scanner(System.in);
         setNumOfPeasantShips(numOfShips());
@@ -41,6 +57,7 @@ public class ShipWarfare {
             if (response.equalsIgnoreCase("f")) {
                 userAttacks = true;
                 System.out.println("Ohh, fight ehh?");
+                delayForSeconds(1);
                 boolean winOrLose = destroyPeasantShipsOrEscape();
                 if (winOrLose == true) {
                     break;
@@ -54,6 +71,7 @@ public class ShipWarfare {
                         break;
                 } else {
                     System.out.println("Phew! Got away safely");
+                    delayForSeconds(2);
                     break;
                 }
 
@@ -63,7 +81,11 @@ public class ShipWarfare {
 
 
     }
-    //This fleet is difficult to defeat as a maximum of 10 ships can run away each volley, they can tank hits
+
+    /**
+     * This fleet is difficult to defeat as a maximum of 10 ships can run away each volley, they can tank hits
+     * @throws Exception in case of errors due to the delay
+     */
     public void littyFleetAttack() throws Exception {
         Scanner userResponse = new Scanner(System.in);
         setNumOfLittyShips(numOfShips());
@@ -83,10 +105,12 @@ public class ShipWarfare {
             } else if (response.equalsIgnoreCase("r")) {
                 if (runFromShips() == false) {
                     System.out.println("Couldn't run away!");
+                    delayForSeconds(1);
                     if (destroyLittyShipsOrEscape())
                         break;
                 } else {
                     System.out.println("Phew! Got away safely");
+                    delayForSeconds(2);
                     break;
                 }
 
@@ -97,34 +121,49 @@ public class ShipWarfare {
 
     }
 
+    /**
+     * Asks user if they would like to fight or run against ships
+     */
 
     public void fightOrRunMessage() {
-        System.out.printf("What do you want to do? Enter \"f\" to fight, and \"r\" to run (we have %d guns)", player.getGuns());
+        System.out.printf("What do you want to do? Enter \"f\" to fight, and \"r\" to run (we have %d guns)\n", player.getGuns());
-
-    }
-
-    public int numOfPeasantShips() {
-        return numOfPeasantShips;
 
     }
 
+    /**
+     * setter method that takes in an integer as an argument
+     * @param numOfLittyShips the number of ships to be used in the litty fleet attack
+     */
     public void setNumOfLittyShips(int numOfLittyShips) {
         this.numOfLittyShips = numOfLittyShips;
         startingLittyShips = numOfLittyShips;
 
     }
 
+    /**
+     * setter method that takes in an integer as an argument
+     * @param numOfPeasantShips the number of ships to be used in the peasant fleet attack
+     */
+
     public void setNumOfPeasantShips(int numOfPeasantShips) {
         this.numOfPeasantShips = numOfPeasantShips;
         startingPeasantShips = numOfPeasantShips;
 
     }
 
-    public void delayForASecond() throws Exception {
+    /**
-        TimeUnit.SECONDS.sleep(1);
+     * delays for a specific amount of seconds, takes an integer as an argument
+     * @param num the seconds to delay
+     * @throws Exception in case of errors due to the delay
+     */
+    public void delayForSeconds(int num) throws Exception {
+        TimeUnit.SECONDS.sleep(num);
     }
 
-    //The number of ships which attack is based on the amount of money one has on hand
+    /**
+     * The number of ships that attack is based on the amount of money one has on hand
+     * @return the number of ships which will attack
+     */
     public int numOfShips() {
 
         int numOfShipsAttacking = 0;
@@ -148,7 +187,11 @@ public class ShipWarfare {
 
     }
 
-    //One in two chance of running away
+    /**
+     * One in two chance of running away
+     * @return true if the user is allowed to run, false if not, the "default" is false
+     */
+
     public boolean runFromShips() {
         userAttacks = false;
         Random randomValue = new Random();
@@ -161,7 +204,12 @@ public class ShipWarfare {
         return false;
     }
 
-    //The loot for defeating a litty fleet is much higher than that of a peasant one
+    /**
+     * The user faces off against the litty ships and either prevails, dies, or runs away
+     * The loot for defeating a litty fleet is much higher than that of a peasant one
+     * @return true if the user wins, loses, or flees, it returns false otherwise
+     * @throws Exception in case of errors due to the delay
+     */
     public boolean destroyLittyShipsOrEscape() throws Exception {
         int calculateLoot = 0;
         int chanceOfEnemyRun = 0;
@@ -173,29 +221,34 @@ public class ShipWarfare {
 
         //Player volley
         while (exitValue == 0) {
-            for (int j = 0; j < player.getGuns(); j++) {
+            if (player.getGuns() > 0) {
-                if (userAttacks == true) {
+                for (int j = 0; j < player.getGuns(); j++) {
-                    int hitOrMiss = randomValue.nextInt(3) + 1;
+                    if (userAttacks == true) {
-                    if (hitOrMiss == 1) {
+                        int hitOrMiss = randomValue.nextInt(3) + 1;
-                        numOfLittyShips--;
+                        if (hitOrMiss == 1) {
-                        if (numOfLittyShips <= 0) {
+                            numOfLittyShips--;
-                            exitValue = 1;
+                            if (numOfLittyShips <= 0) {
-                            break;
+                                exitValue = 1;
+                                break;
+                            }
+                            System.out.println("Got eem");
+                            delayForSeconds(1);
+                        } else if (hitOrMiss == 2) {
+                            System.out.printf("ARRG! We missed %s\n", player.getName());
+                            delayForSeconds(1);
+                        } else {
+                            System.out.println("Darn! Their fleet tanked our attack");
+                            delayForSeconds(1);
                         }
-                        System.out.println("Got eem");
+
-                        delayForASecond();
+
-                    } else if (hitOrMiss == 2) {
-                        System.out.printf("ARRG! We missed %s\n", player.getName());
-                        delayForASecond();
                     } else {
-                        System.out.println("Darn! Their fleet tanked our attack");
+                        continue;
-                        delayForASecond();
                     }
-
-
-                } else {
-                    continue;
                 }
+            } else {
+                System.out.printf("%s! We don't have any GUNS!!!!\n",player.getName());
+                delayForSeconds(1);
             }
 
 
@@ -203,24 +256,26 @@ public class ShipWarfare {
                 exitValue = 1;
                 break;
             }
-            chanceOfEnemyRun = randomValue.nextInt(2) + 1;
+            if (player.getGuns() > 0) {
-            if (chanceOfEnemyRun == 2) {
+                if (chanceOfEnemyRun == 2) {
-                howMuchRun = randomValue.nextInt(10) + 1;
+                    chanceOfEnemyRun = randomValue.nextInt(2) + 1;
-                if (howMuchRun != 0 && howMuchRun < numOfLittyShips) {
+                    howMuchRun = randomValue.nextInt(10) + 1;
+                    if (howMuchRun != 0 && howMuchRun < numOfLittyShips) {
 
 
-                    setNumOfLittyShips(numOfLittyShips - howMuchRun);
+                        setNumOfLittyShips(numOfLittyShips - howMuchRun);
-                    if (userAttacks == true) {
+                        if (userAttacks == true) {
-                        System.out.printf("Cowards! %d ships ran away %s!\n", howMuchRun, player.getName());
+                            System.out.printf("Cowards! %d ships ran away %s!\n", howMuchRun, player.getName());
-                    } else {
+                        } else {
-                        System.out.printf("Escaped %d of them!\n", howMuchRun);
+                            System.out.printf("Escaped %d of them!\n", howMuchRun);
+                        }
                     }
                 }
             }
 
             System.out.printf("%d ships remaining\n", numOfLittyShips);
             System.out.println("Oh no, they are taking the offensive!");
-            delayForASecond();
+            delayForSeconds(1);
             //Computer volley
             int takeGunChance = randomValue.nextInt(4) + 1;
             if (takeGunChance == 1 && player.getGuns() > 0) {
@@ -234,7 +289,7 @@ public class ShipWarfare {
                 break;
             }
             System.out.printf("EEK, our current ship status is %d%% \n", player.getHP());
-            delayForASecond();
+            delayForSeconds(1);
             if (userAttacks == false) {
                 userAttacks = true;
             }
@@ -245,8 +300,10 @@ public class ShipWarfare {
             if (response.equalsIgnoreCase("r")) {
                 if (runFromShips() == false) {
                     System.out.println("Couldn't run away");
+                    delayForSeconds(1);
                 } else {
-                    exitValue = 3;
+                    System.out.println("Phew! Got away safely");
+                    delayForSeconds(2);
                     break;
                 }
             }
@@ -257,15 +314,19 @@ public class ShipWarfare {
 
         if (exitValue == 1) {
             System.out.printf("\nGot eem\nVictory!\nIt appears we have defeated the enemy fleet and made it out at %d%% ship status\n", player.getHP());
+            delayForSeconds(1);
             calculateLoot = (randomValue.nextInt(startingLittyShips) + startingLittyShips) * 300;
             player.setMoney(player.getMoney() + calculateLoot);
             System.out.printf("We got $%,d!\n", calculateLoot);
+            delayForSeconds(2);
             return true;
         } else if (exitValue == 2) {
             player.gameOver();
+
             return true;
         } else if (exitValue == 3) {
             System.out.printf("We made it out at %d%% ship status!\n", player.getHP());
+            delayForSeconds(2);
             return true;
         }
         return false;
@@ -273,6 +334,11 @@ public class ShipWarfare {
 
     }
 
+    /**
+     * The user faces off against the peasant ships and either prevails, dies, or runs away
+     * @return true if the user wins, loses, or flees, it returns false otherwise
+     * @throws Exception in case of errors due to the delay
+     */
 
     public boolean destroyPeasantShipsOrEscape() throws Exception {
         int calculateLoot = 0;
@@ -285,51 +351,62 @@ public class ShipWarfare {
 
         //Player volley
         while (exitValue == 0) {
-            for (int j = 0; j < player.getGuns(); j++) {
+            if (player.getGuns() > 0) {
-                if (userAttacks == true) {
+
-                    int hitOrMiss = randomValue.nextInt(2) + 1;
+                for (int j = 0; j < player.getGuns(); j++) {
-                    if (hitOrMiss == 2) {
+                    if (userAttacks == true) {
-                        numOfPeasantShips--;
+                        int hitOrMiss = randomValue.nextInt(2) + 1;
-                        if (numOfPeasantShips <= 0) {
+                        if (hitOrMiss == 2) {
-                            exitValue = 1;
+                            numOfPeasantShips--;
-                            break;
+                            if (numOfPeasantShips <= 0) {
+                                exitValue = 1;
+                                break;
+                            }
+                            System.out.println("Got eem");
+                            delayForSeconds(1);
+                        } else {
+                            System.out.printf("ARRG! We missed %s\n", player.getName());
+                            delayForSeconds(1);
                         }
-                        System.out.println("Got eem");
+
-                        delayForASecond();
+
                     } else {
-                        System.out.printf("ARRG! We missed %s\n", player.getName());
+                        continue;
-                        delayForASecond();
                     }
-
-
-                } else {
-                    continue;
                 }
             }
+            else{
+                System.out.printf("%s! We don't have any GUNS!!!!\n", player.getName());
+                delayForSeconds(1);
+
+            }
 
 
             if (numOfPeasantShips <= 0) {
                 exitValue = 1;
                 break;
             }
-            chanceOfEnemyRun = randomValue.nextInt(2) + 1;
+            if (player.getGuns() > 0) {
-            if (chanceOfEnemyRun == 2) {
+                chanceOfEnemyRun = randomValue.nextInt(2) + 1;
-                howMuchRun = randomValue.nextInt(15) + 1;
+                if (chanceOfEnemyRun == 2) {
-                if (howMuchRun != 0 && howMuchRun < numOfPeasantShips) {
+                    howMuchRun = randomValue.nextInt(15) + 1;
+                    if (howMuchRun != 0 && howMuchRun < numOfPeasantShips) {
 
 
-                    setNumOfPeasantShips(numOfPeasantShips - howMuchRun);
+                        setNumOfPeasantShips(numOfPeasantShips - howMuchRun);
-                    if (userAttacks == true) {
+                        if (userAttacks == true) {
-                        System.out.printf("Ahhh, %d ships ran away %s!\n", howMuchRun, player.getName());
+                            System.out.printf("Ahhh, %d ships ran away %s!\n", howMuchRun, player.getName());
-                    } else {
+                        } else {
-                        System.out.printf("Escaped %d of them!\n", howMuchRun);
+                            System.out.printf("Escaped %d of them!\n", howMuchRun);
+                        }
                     }
                 }
             }
 
             System.out.printf("%d ships remaining\n", numOfPeasantShips);
+            delayForSeconds(1);
             System.out.println("Oh no, they are taking the offensive!");
-            delayForASecond();
+            delayForSeconds(1);
             //Computer volley
             int takeGunChance = randomValue.nextInt(4) + 1;
             if (takeGunChance == 1 && player.getGuns() > 0) {
@@ -343,7 +420,7 @@ public class ShipWarfare {
                 break;
             }
             System.out.printf("EEK, our current ship status is %d%% \n", player.getHP());
-            delayForASecond();
+            delayForSeconds(1);
             if (userAttacks == false) {
                 userAttacks = true;
             }
@@ -366,15 +443,18 @@ public class ShipWarfare {
 
         if (exitValue == 1) {
             System.out.printf("\nGot eem\nVictory!\nIt appears we have defeated the enemy fleet and made it out at %d%% ship status\n", player.getHP());
+            delayForSeconds(1);
             calculateLoot = (randomValue.nextInt(startingPeasantShips) + startingPeasantShips) * 100;
             player.setMoney(player.getMoney() + calculateLoot);
             System.out.printf("We got $%,d!", calculateLoot);
+            delayForSeconds(2);
             return true;
         } else if (exitValue == 2) {
             player.gameOver();
             return true;
         } else if (exitValue == 3) {
             System.out.printf("We made it out at %d%% ship status!\n", player.getHP());
+            delayForSeconds(2);
             return true;
         }
         return false;

src/Start.java

@@ -3,22 +3,42 @@ public class Start
 {
     private Player player;
 
+    /**
+     * gets the player instance variable. The method returns a copy of the instance variable for encapsulation purposes.
+     *
+     * @return playerDummy -- playerDummy is a copy of the player instance variable.
+     */
     public Player getPlayer() {
         Player playerTemp = new Player(player);
         return playerTemp;
     }
 
+    /**
+     * sets the player instance variable equal to a copy of the parameter -- a copy is used for encapsulation purposes.
+     *
+     * @param player is a Player object that will replace the current instance of the player instance variable.
+     */
     public void setPlayer(Player player) {
         Player playerTemp = new Player(player);
         this.player = playerTemp;
     }
 
+    /**
+     * Asks the user to input the name that they would like to be called in the game
+     *
+     * @param name the name that you would like to be called in the game
+     */
     public void setFirm (String name) {
         if (name.length() <= 22) {
             player.setName(name);
         }
     }
-    public void intialize()
+
+    /**
+     * Initializes the game by asking for your name and if you would like to start with either: 1) money and a debt or
+     * 2) guns and no cash/debt.
+     */
+    public void initialize()
     {
         Scanner userInput = new Scanner(System.in);
         System.out.println("Taipan, \nWhat will you name your firm:");
@@ -42,10 +62,15 @@ public class Start
             player.setBank(999999999);
             player.setGuns(999);
             player.setHP(99999999);
+            player.setCargoSpace(99999999);
         }
     }
 
 
+    /**
+     * Copy constructor.
+     * @param player object of the class Player
+     */
     public Start(Player player)
     {
         Player playerTemp = new Player(player);

src/TaipanShop.java

@@ -3,108 +3,170 @@ import java.util.Scanner;
 public class TaipanShop {
 
     private Player player;
-    private int cargoSpace = 60;
-    private int currentCargo = 0;
     private int opiumPrice = 16000;
     private int silkPrice = 1600;
     private int armsPrice = 160;
     private int generalPrice = 8;
 
+    /**
+     * This method is evoked if the user is eligible to win, and chooses to end the game (by winning).
+     */
     public void retire(){
         player.setRetire(true);
         System.out.println("You win!");
+        System.exit(0);
     }
 
+    /**
+     * sets the player instance variable equal to a copy of the parameter -- a copy is used for encapsulation purposes.
+     *
+     * @param player is a Player object that will replace the current instance of the player instance variable.
+     */
     public void setPlayer(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
+    /**
+     * gets the player instance variable. The method returns a copy of the instance variable for encapsulation purposes.
+     *
+     * @return playerDummy -- playerDummy is a copy of the player instance variable.
+     */
     public Player getPlayer(){
         Player playerDummy = new Player(player);
         return playerDummy;
     }
 
+    /**
+     * constructor; only runs when a Player object is provided. The constructor is fully encapsulated.
+     *
+     * @param player is a Player object that will be copied and the player instance variable is set to the copy.
+     */
     public TaipanShop(Player player){
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
-    public int getCargoSpace() {
+    /**
-        return cargoSpace;
+     * getter for opiumPrice instance variable.
-    }
+     *
-
+     * @return opiumPrice -- the price of opium in the shop
-    public void setCargoSpace(int cargoSpace) {
+     */
-        if(cargoSpace > 0){
-            this.cargoSpace = cargoSpace;
-        }
-    }
-
     public int getOpiumPrice() {
         return opiumPrice;
     }
 
+    /**
+     * setter for the opiumPrice instance variable. Runs as long as the parameter is greater than 0.
+     *
+     * @param opiumPrice -- what the instance variable opiumPrice should be changed to.
+     */
     public void setOpiumPrice(int opiumPrice) {
         if(opiumPrice > 0){
             this.opiumPrice = opiumPrice;
         }
     }
 
+    /**
+     * getter for silkPrice instance variable.
+     *
+     * @return silkPrice -- the price of silk in the shop.
+     */
     public int getSilkPrice() {
         return silkPrice;
     }
 
+    /**
+     * setter for the silkPrice instance variable. Runs as long as the parameter is greater than 0.
+     *
+     * @param silkPrice -- what the instance variable silkPrice should be changed to.
+     */
     public void setSilkPrice(int silkPrice) {
         if(silkPrice > 0){
             this.silkPrice = silkPrice;
         }
     }
 
+    /**
+     * getter for armsPrice instance variable.
+     *
+     * @return armsPrice -- the price of arms in the shop.
+     */
     public int getArmsPrice() {
         return armsPrice;
     }
 
+    /**
+     * setter for the armsPrice instance variable. Runs as long as the parameter is greater than 0.
+     *
+     * @param armsPrice -- what the instance variable armsPrice should be changed to.
+     */
     public void setArmsPrice(int armsPrice) {
         if(armsPrice > 0){
             this.armsPrice = armsPrice;
         }
     }
 
+    /**
+     * getter for generalPrice instance variable.
+     *
+     * @return generalPrice -- the price of general cargo in the shop.
+     */
     public int getGeneralPrice() {
         return generalPrice;
     }
 
+    /**
+     * setter for the generalPrice instance variable. Runs as long as the parameter is greater than 0.
+     *
+     * @param generalPrice -- what the instance variable generalPrice should be changed to.
+     */
     public void setGeneralPrice(int generalPrice) {
         if(generalPrice > 0){
             this.generalPrice = generalPrice;
         }
     }
 
+    /**
+     * this method is evoked if the user has decided to travel elsewhere.
+     */
     public void travel(){
         Travel travel = new Travel(player);
         travel.travelTo();
         player = travel.getPlayer();
     }
 
+    /**
+     * this method is evoked if the user wants to use the warehouse to store items or take items out.
+     */
     public void warehouse(){
         Warehouse warehouse = new Warehouse(player);
         warehouse.changeWarehouse();
         player = warehouse.getPlayer();
     }
 
+    /**
+     * this method is evoked if the user wants to use the bank to deposit or withdraw money.
+     */
     public void bank(){
         Bank bank = new Bank(player);
         bank.bank();
         player = bank.getPlayer();
     }
 
+    /**
+     * this method is evoked if the user wants to use get a loan or pay a loan off.
+     */
     public void loan(){
         loanShark loan = new loanShark(player);
         loan.loanMoney();
         player = loan.getPlayer();
     }
-    
+
-    private void updatePrices(){
+    /**
+     * this method is when the shop is accessed, randomizing the prices of all the items.
+     */
+    public void updatePrices(){
         String s = "\n" + player.getName() + ", the price of ";
         double value = 80*Math.random();
         Random rand = new Random();
@@ -112,6 +174,8 @@ public class TaipanShop {
         silkPrice = (rand.nextInt(201) + 60)*10;
         armsPrice = (rand.nextInt(21) + 6)*10;
         generalPrice = rand.nextInt(17) + 4;
+
+        // there is a 10% chance that the price of an item is increased/decreased beyond its regular range.
         if(value < 8){
             if(value < 2){
                 if(value < 1){
@@ -149,12 +213,15 @@ public class TaipanShop {
         }
     }
 
-    private void printShop(){
+    /**
-        currentCargo = player.getOpiumHeld()+player.getGuns()*10+player.getSilkHeld()+player.getArmsHeld()+player.getGeneralHeld();
+     * this method prints the shop UI and the player's inventory and status.
-        if(cargoSpace - currentCargo < 0){
+     */
+    public void printShop(){
+        int currentCargo = player.getOpiumHeld()+player.getGuns()*10+player.getSilkHeld()+player.getArmsHeld()+player.getGeneralHeld();
+        if(player.getCargoSpace() - currentCargo < 0){
             System.out.println("Hold: Overloaded" + "          Guns: " + player.getGuns() + "          HP: " + player.getHP() +"%");
         }else{
-            System.out.println("Hold: " + (cargoSpace-currentCargo) + "          Guns: " + player.getGuns() + "          HP: " + player.getHP() +"%");
+            System.out.println("Hold: " + (player.getCargoSpace()-currentCargo) + "          Guns: " + player.getGuns() + "          HP: " + player.getHP() +"%");
         }
         System.out.println("-------------------------------------------------------------");
         System.out.println("     Opium: " + player.getOpiumHeld() + "      Silk: " + player.getSilkHeld());
@@ -166,7 +233,14 @@ public class TaipanShop {
         System.out.println("     Arms: " + armsPrice + "       General: " + generalPrice);
     }
 
-    public void atLocationOne(boolean notDone, Scanner input){
+    /**
+     * This method is evoked if the user is at the location one port.
+     */
+    public void atLocationOne(){
+        boolean notDone = true;
+        Scanner input = new Scanner(System.in);
+
+        // as long as the user does not enter a valid input, the code will run in a loop forever.
         while(notDone){
             printShop();
             System.out.println("\nShall I Buy, Sell, Visit Bank, Get Loans, Transfer Cargo, or Quit Trading?");
@@ -174,6 +248,8 @@ public class TaipanShop {
             if (response.equalsIgnoreCase("B")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to buy, " + player.getName() + "?");
+
+                // when buying an item, the user must have the right amount of money, and buy non-negative amounts.
                 while (notDone2) {
                     response = input.nextLine();
                     if (response.equalsIgnoreCase("O")) {
@@ -236,7 +312,8 @@ public class TaipanShop {
 
                 }
 
-            } else if (response.equalsIgnoreCase("S")) {
+            } // when selling, the user must enter a non-negative amount of items, and not more than what they have.
+            else if (response.equalsIgnoreCase("S")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to sell, " + player.getName() + "?");
                 while (notDone2) {
@@ -307,14 +384,22 @@ public class TaipanShop {
                 warehouse();
             }else if (response.equalsIgnoreCase("G")||response.equalsIgnoreCase("L")) {
                 loan();
-            }else if (response.equalsIgnoreCase("Q")) {
+            } // if the user wishes to quit trading, they may do so. Doing this breaks them out of the loop.
+            else if (response.equalsIgnoreCase("Q")) {
                 travel();
                 notDone = false;
             }
         }
     }
 
-    public void notAtLocationOne(boolean notDone, Scanner input){
+    /**
+     * This method is evoked when the user is at any port other than location one.
+     */
+    public void notAtLocationOne(){
+        boolean notDone = true;
+        Scanner input = new Scanner(System.in);
+
+        // as long as the user does not enter a valid input, the code will run in a loop forever.
         while(notDone){
             printShop();
             System.out.println("\nShall I Buy, Sell, or Quit Trading?");
@@ -322,6 +407,8 @@ public class TaipanShop {
             if (response.equalsIgnoreCase("B")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to buy, " + player.getName() + "?");
+
+                // when buying an item, the user must have the right amount of money, and buy non-negative amounts.
                 while (notDone2) {
                     response = input.nextLine();
                     if (response.equalsIgnoreCase("O")) {
@@ -384,7 +471,8 @@ public class TaipanShop {
 
                 }
 
-            } else if (response.equalsIgnoreCase("S")) {
+            } // when selling, the user must enter a non-negative amount of items, and not more than what they have.
+            else if (response.equalsIgnoreCase("S")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to sell, " + player.getName() + "?");
                 while (notDone2) {
@@ -447,14 +535,22 @@ public class TaipanShop {
                         }
                     }
                 }
-            } else if (response.equalsIgnoreCase("Q")) {
+            } // if the user wishes to quit trading, they may do so. Doing this breaks them out of the loop.
+            else if (response.equalsIgnoreCase("Q")) {
                 travel();
                 notDone = false;
             }
         }
     }
 
-    public void retireAndLocationOne(boolean notDone, Scanner input){
+    /**
+     * this method is run if the user is eligible to win, and is at location one.
+     */
+    public void retireAndLocationOne(){
+        boolean notDone = true;
+        Scanner input = new Scanner(System.in);
+
+        // as long as the user does not enter a valid input, the code will run in a loop forever.
         while(notDone){
             printShop();
             System.out.println("\nShall I Buy, Sell, Visit Bank, Transfer Cargo, Get Loans, Retire, or Quit Trading?");
@@ -462,6 +558,8 @@ public class TaipanShop {
             if (response.equalsIgnoreCase("B")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to buy, " + player.getName() + "?");
+
+                // when buying an item, the user must have the right amount of money, and buy non-negative amounts.
                 while (notDone2) {
                     response = input.nextLine();
                     if (response.equalsIgnoreCase("O")) {
@@ -523,7 +621,8 @@ public class TaipanShop {
                     }
                 }
 
-            } else if (response.equalsIgnoreCase("S")) {
+            } // when selling, the user must enter a non-negative amount of items, and not more than what they have.
+            else if (response.equalsIgnoreCase("S")) {
                 boolean notDone2 = true;
                 System.out.println("What do you wish me to sell, " + player.getName() + "?");
                 while (notDone2) {
@@ -592,28 +691,36 @@ public class TaipanShop {
                 bank();
             } else if (response.equalsIgnoreCase("T")) {
                 warehouse();
-            }else if (response.equalsIgnoreCase("G")||response.equalsIgnoreCase("L")) {
+            } else if (response.equalsIgnoreCase("G")||response.equalsIgnoreCase("L")) {
                 loan();
-            }else if (response.equalsIgnoreCase("Q")) {
+            } // if the user wishes to quit trading, they may do so. Doing this breaks them out of the loop.
+            else if (response.equalsIgnoreCase("Q")) {
                 travel();
                 notDone = false;
-            } else if (response.equalsIgnoreCase("R")) {
+            } // if the user wishes to retire and win the game, they may do so. Doing this breaks them out of the loop.
+            else if (response.equalsIgnoreCase("R")) {
                 retire();
                 notDone = false;
             }
         }
     }
 
+    /**
+     * the general method that utilizes all the other methods to form a fully functioning shop.
+     */
     public void shop() {
         updatePrices();
-        Scanner input = new Scanner(System.in);
+
-        boolean notDone = true;
+        // first case is triggered if the user is at location one, and has less than $1 million net worth
         if (player.getLocation() == 1 && player.getBank()+player.getMoney()-player.getDebt() < 1000000) {
-            atLocationOne(notDone, input);
+            atLocationOne();
-        }else if(player.getLocation() != 1) {
+        } // the second case is triggered if the user is at a location other than location one.
-            notAtLocationOne(notDone, input);
+        else if(player.getLocation() != 1) {
-        }else{
+            notAtLocationOne();
-            retireAndLocationOne(notDone, input);
+        } // the last case is triggered when the other conditions are not met; it is triggered when the user has a net
+        // worth that is greater than or equal to $1 million and is at location one.
+        else{
+            retireAndLocationOne();
         }
     }
 }

src/Travel.java

@@ -5,21 +5,42 @@ public class Travel {
 
     private Player player;
 
+    /**
+     * sets the player instance variable equal to a copy of the parameter -- a copy is used for encapsulation purposes.
+     *
+     * @param player is a Player object that will replace the current instance of the player instance variable.
+     */
     public void setPlayer(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
+    /**
+     * getter method for obtaining a player object.
+     *
+     * @return returns player object
+     */
     public Player getPlayer() {
         Player playerDummy = new Player(player);
         return playerDummy;
     }
 
+    /**
+     * constructor; only runs when a Player object is provided. The constructor is fully encapsulated.
+     *
+     * @param player is a Player object that will be copied and the player instance variable is set to the copy.
+     */
     public Travel(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
+    /**
+     * When provided a location number: the method returns a print statement stating the location's name and call another
+     * method to change the location of the Player object.
+     *
+     * @param locationOfTravel is a Player object that will be copied and the player instance variable is set to the copy.
+     */
     private void seaAtlas(int locationOfTravel) {
         switch (locationOfTravel) {
             case 1:
@@ -53,25 +74,41 @@ public class Travel {
         }
     }
 
+    /**
+     * Based on random chance either attacks the player with enemy ships, throws them to a different location or does nothing.
+     *
+     * @param locationOfTravel is used to see where the player is going to travel, just in case their location is changed
+     *                         by a typhoon.
+     **/
     private void randomEventSea(int locationOfTravel) throws Exception {
         Random rand = new Random();
         int randGenNum = rand.nextInt(3) + 1;
         if (randGenNum == 1) {
             peasantFleet();
-        } else if (randGenNum == 2) {
+        }else if (randGenNum == 2) {
             disaster(locationOfTravel);
+            System.out.println("We made it!");
         }
-        System.out.println("We made it!");
     }
 
+    /**
+     * Based on random chance either throws the player character off course, or continues them on their way to their
+     * destination.
+     *
+     * @param locationOfTravel is used to see where the player is going to travel, just in case their location is changed
+     *                         by a typhoon.
+     **/
     private void disaster(int locationOfTravel) {
+        //Tells player that there is a storm approaching.
         System.out.print("Storm " + player.getName() + "! ");
         Random rand = new Random();
         int randGenNum = rand.nextInt(5) + 1;
 
+        //If the player lands within this range, nothing happens to them
+        //Else they randomly get thrown into a location they weren't planning on going to(Anything but location of Travel).
         if (randGenNum <= 2) {
             System.out.println(" We made it through!");
-        } else {
+        }else {
             while (randGenNum == locationOfTravel) {
                 randGenNum = rand.nextInt(7) + 1;
                 if (randGenNum != locationOfTravel) {
@@ -82,39 +119,56 @@ public class Travel {
         }
     }
 
+    /**
+     * To use the peasant fleet class while still maintaining encapsulation we have to create a ShipWarefare object and
+     * run the method from there. After the method has been run we can update the player object in this class.
+     * @throws Exception throws Exception so that we can use the time library to make the player if we want to.
+     **/
     public void peasantFleet() throws Exception {
         ShipWarfare attackShip = new ShipWarfare(player);
         attackShip.peasantFleetAttack();
         player = attackShip.getPlayer();
     }
 
+    /**
+     *Used to travel between different areas inside of the game world.
+     * If the player's inventory is too full it won't run.
+     * Also calculates loan and bank interest between the jumps between islands.
+     **/
     public void travelTo() {
         Scanner keyboard = new Scanner(System.in);
         String response;
         int tempInt;
         boolean hasTraveled = false;
 
-        while (true) {
+        //Only lets the player leave the port if their inventory is greater than or equal to the sum of the items in the inventory.
-            System.out.println("\n" + player.getName() + ", do you wish to go to:\n");
+        if(player.getCargoSpace() >= (player.getOpiumHeld()+ (player.getGuns()*10)+player.getSilkHeld() + player.getArmsHeld() + player.getGeneralHeld())){
-            System.out.println("1) Hong Kong, 2) Shanghai, 3) Nagasaki,\n4) Saigon, 5) Manila, 6) Singapore, or 7) Batavia?");
+            while (true) {
+                System.out.println("\n" + player.getName() + ", do you wish to go to:\n");
+                System.out.println("1) Hong Kong, 2) Shanghai, 3) Nagasaki,\n4) Saigon, 5) Manila, 6) Singapore, or 7) Batavia?");
 
-            response = keyboard.nextLine();
+                response = keyboard.nextLine();
-            try {
+                //Just in case the player types something that was not intended. It will refresh the question and ask it again
-                tempInt = Integer.parseInt(response);
+                try {
-                System.out.println(tempInt + " " + player.getLocation());
+                    tempInt = Integer.parseInt(response);
-                if (tempInt != player.getLocation()) {
+                    //Makes sure you can't travel to your own location.
-                    randomEventSea(tempInt);
+                    if (tempInt != player.getLocation()) {
-                    seaAtlas(tempInt);
+                        randomEventSea(tempInt);
-                    hasTraveled = true;
+                        seaAtlas(tempInt);
-                    player.setBank((int)(player.getBank() * 1.01));
+                        hasTraveled = true;
-                    player.setDebt((int)(player.getDebt() * 1.01));
+                        player.setBank((int) (player.getBank() * 1.01));
-                } else System.out.println("\nYou're already here " + player.getName() + ".");
+                        player.setDebt((int) (player.getDebt() * 1.01));
-            } catch (Exception e) {
+                    } else System.out.println("\nYou're already here " + player.getName() + ".");
-                System.out.print("\nSorry, " + player.getName() + " could you say that again?");
+                } catch (Exception e) {
-            }
+                    System.out.print("\nSorry, " + player.getName() + " could you say that again?");
-            if (hasTraveled) {
+                }
-                break;
+                if (hasTraveled) {
+                    break;
+                }
             }
         }
+        else{
+            System.out.println(player.getName() + " the cargo is too heavy! We can't set sail!");
+        }
     }
 }

src/Warehouse.java

@@ -1,5 +1,9 @@
 import java.util.Scanner;
 
+/**
+ * The purpose of this class is to create a warehouse where the goods
+ * can be safely stored without holing space on the ship!
+ */
 public class Warehouse {
     /*private int wOpium = 0;
     private int wSilk = 0;
@@ -7,43 +11,75 @@ public class Warehouse {
     private int wArms = 0;*/
     private Player player;
 
+    /**
+     * setter method that takes in a Player object as an argument.
+     *
+     * @param player object of the class Player
+     */
 
     public void setPlayer(Player player) {
         Player playerDumy = new Player(player);
         this.player = playerDumy;
     }
 
+    /**
+     * getter method for obtaining a player object.
+     *
+     * @return returns player object
+     */
+
     public Player getPlayer() {
         Player playerDummy = new Player(player);
         return playerDummy;
     }
 
+    /**
+     * Class Constructor that takes in a type player as a parameter
+     *
+     * @param player object of the class Player
+     */
+
     public Warehouse(Player player) {
         Player playerDummy = new Player(player);
         this.player = playerDummy;
     }
 
-
+    /**
+     * This method adds an amount of a certain good
+     * the user is prompted to enter the amount they would like to
+     * add followed by the good they would like to add to the warehouse.
+     * the method checks if the player has sufficient goods to transfer, and if the player does
+     * then the method executes the transfer
+     *
+     */
     public void addAmount() {
         boolean askGood = false;
         String amount;
         int finalAmount = 0;
         System.out.println("Please enter the amount of the good you would like to ADD.");
         Scanner keyboard = new Scanner(System.in);
-        amount = keyboard.nextLine();
+        amount = keyboard.nextLine();//Asks the user for the amount of the good they would like to add
+         /*The try function ensures that the program does not crash
+         due to any errors while giving the program an incorrect input*/
         try {
+            //The if statement checks that you have enough resources to make the transfer
             if (Integer.parseInt(amount) <= player.getOpiumHeld() || Integer.parseInt(amount) <= player.getSilkHeld() || Integer.parseInt(amount) <= player.getGeneralHeld() || Integer.parseInt(amount) <= player.getArmsHeld()) {
                 finalAmount = Integer.parseInt(amount);
                 askGood = true;
-            } else {
+            }
+            //Else statement lets the user know that they do not hav enough goods to make the requested transfer
+            else {
                 System.out.println("Nice try but you don't have any items of that quantity!");
                 askGood = false;
             }
+            //Ensures that goods are only transferred if they have the specified amount
+            //The user is prompted to enter which good they want to transfer
             if (askGood == true) {
                 String good;
                 System.out.println("Please enter a good to transfer O, S, G, A :");
                 good = keyboard.nextLine();
                 int held = 0;
+                //The following set of loops check to see which good the user has selected and makes the transfer
                 if (Integer.parseInt(amount) > 0) {
                     if (good.equalsIgnoreCase("O")) {
                         if (player.getOpiumHeld() >= Integer.parseInt(amount)) {
@@ -81,36 +117,57 @@ public class Warehouse {
                             System.out.println("You don't even have that much Arms!");
                         }
                     }
-                } else {
+                }
+                //Ensures no negative amounts are entered
+                else {
                     System.out.println("Sorry this transfer cannot be made");
                 }
             }
+        //If the program errors out this is the message displayed and the method is re-run, so that the game does not end.
         } catch (Exception e) {
             System.out.println("Wait, that's not a valid input please try again");
         }
     }
 
+    /**
+     * This method removes an amount of a certain good
+     * the user is prompted to enter the amount they would like to
+     * remove followed by the good they would like to remove from the warehouse.
+     * the method checks if the player has sufficient goods to transfer, and if the player does
+     * then the method executes the transfer
+     *
+     */
+
     public void removeAmount() {
         String amount;
         boolean askGood = false;
         int finalAmount = 0;
         System.out.println("Please enter the amount of the good you would like to REMOVE");
         Scanner keyboard = new Scanner(System.in);
+        //Prompts the user for the amount they would like to remove
         amount = keyboard.nextLine();
+        //The if statement checks that you have enough resources to make the transfer
         try {
+            //The if statement checks that you have enough resources to make the transfer
             if (Integer.parseInt(amount) <= player.getwOpium() || Integer.parseInt(amount) <= player.getwSilk() || Integer.parseInt(amount) <= player.getwGeneral() || Integer.parseInt(amount) <= player.getwArms()) {
                 finalAmount = Integer.parseInt(amount);
                 askGood = true;
-            } else {
+            }
+            //Else statement lets the user know that they do not hav enough goods to make the requested transfer
+            else {
                 System.out.println("Nice try but you don't have any items of that quantity in the warehouse!");
                 askGood = false;
             }
 
+            //Ensures that goods are only transferred if they have the specified amount
+            //The user is prompted to enter which good they want to transfer
+
             if (askGood == true) {
                 String good;
                 System.out.println("Please enter a good to transfer O, S, G, A :");
                 good = keyboard.nextLine();
                 int held = 0;
+                //The following set of loops check to see which good the user has selected and makes the transfer and amount > 0
                 if (Integer.parseInt(amount) > 0) {
                     if (good.equalsIgnoreCase("O")) {
                         if (player.getwOpium() >= Integer.parseInt(amount)) {
@@ -122,7 +179,7 @@ public class Warehouse {
                         }
                     } else if (good.equalsIgnoreCase("S")) {
                         if (player.getwSilk() >= Integer.parseInt(amount)) {
-							player.setwSilk(player.getwSilk() - Integer.parseInt(amount));
+                            player.setwSilk(player.getwSilk() - Integer.parseInt(amount));
                             held = player.getSilkHeld();
                             player.setSilkHeld(held + finalAmount);
                         } else {
@@ -130,7 +187,7 @@ public class Warehouse {
                         }
                     } else if (good.equalsIgnoreCase("G")) {
                         if (player.getwGeneral() >= Integer.parseInt(amount)) {
-							player.setwGeneral(player.getwGeneral() - Integer.parseInt(amount));
+                            player.setwGeneral(player.getwGeneral() - Integer.parseInt(amount));
                             held = player.getGeneralHeld();
                             player.setGeneralHeld(held + finalAmount);
                         } else {
@@ -139,7 +196,7 @@ public class Warehouse {
                         }
                     } else if (good.equalsIgnoreCase("A")) {
                         if (player.getwArms() >= Integer.parseInt(amount)) {
-							player.setwArms(player.getwArms() - Integer.parseInt(amount));
+                            player.setwArms(player.getwArms() - Integer.parseInt(amount));
                             held = player.getArmsHeld();
                             player.setArmsHeld(held + finalAmount);
                         } else {
@@ -147,16 +204,24 @@ public class Warehouse {
 
                         }
                     }
-                } else {
+                }
+                //Ensures the value entered is positive
+                else {
                     System.out.println("Sorry this transfer cannot be made");
                 }
             }
-        }catch (Exception e){
+        }
+        //If the program errors out this is the message displayed and the method is re-run, so that the game does not end.
+        catch (Exception e){
             System.out.println("Wait, that's not a valid input please try again");
         }
     }
 
-
+    /**
+     * This method prints the stock that is in the warehouse currently using the get and set
+     * methods from the player class. This is to allow the user to be able to know how much they have
+     * stored in the warehouse
+     */
     public void showWarehouse() {
         System.out.println("--------------------\nWarehouse\n--------------------");
         System.out.println("Opium : " + player.getwOpium());
@@ -165,7 +230,11 @@ public class Warehouse {
         System.out.println("Arms : " + player.getwArms());
     }
 
-
+    /**
+     * This method combines the add and remove methods and prompts the user to
+     * enter what they would like to do. Add or remove and accordingly invokes
+     * the required methods
+     */
     public void changeWarehouse() {
         boolean keepGoing = true;
         while (keepGoing) {
@@ -187,6 +256,7 @@ public class Warehouse {
             }
 
             String check;
+            //Check to see if the player wants to continue in the warehouse or they are done
             System.out.println("Would you like to do any other business? Y / N?");
             check = keyboard.nextLine();
 			check = keyboard.nextLine();
@@ -199,7 +269,4 @@ public class Warehouse {
         }
     }
 
-    public static void main(String[] args) {
-
-    }
 }

src/loanShark.java

@@ -2,38 +2,86 @@ import java.util.Scanner;
 
 public class loanShark {
 	private Player player;
+	/**
+	 * setter method that takes in a Player object as an argument.
+	 *
+	 * @param player object of the class Player
+	 */
 	public void setPlayer(Player player) {
 		Player playerDummy = new Player(player);
 		this.player = playerDummy;
 	}
-
+	/**
+	 * getter method for obtaining a player object.
+	 *
+	 * @return returns player object
+	 */
 	public Player getPlayer(){
 		Player playerDummy = new Player(player);
 		return playerDummy;
 	}
-
+	/**
+	 * Class Constructor that takes in a type player as a parameter
+	 *
+	 * @param player object of the class Player
+	 */
 	public loanShark(Player player){
 		Player playerDummy = new Player(player);
 		this.player = playerDummy;
 	}
 
+	/**
+	 * This methods purpose is to loan the player the funds it wants
+	 * or pay its outstanding debts. The method prompts the user if they
+	 * would like to borrow money or repay. depending on what the player chooses
+	 * the corresponding loop is evoked. The player can only be loaned 2 times the
+	 * money they have minus the debt id their debt exceeds the cash balance, the loan
+	 * cannot be given.
+	 */
 	public void loanMoney() {
 		boolean keepGoing = true;
 		while(keepGoing) {
-			int loanAsk = 0;
-			System.out.println("Please enter how much you would like to borrow");
-			Scanner keyboard = new Scanner(System.in);
-			loanAsk = keyboard.nextInt();
-			if(loanAsk <= 2*(player.getMoney() - player.getDebt())) {
-				player.setDebt(player.getDebt() + loanAsk);
-				player.setMoney(player.getMoney() + loanAsk);
-			}
-			//updated
-			else{
-				System.out.println("Sorry you can't be loaned that much");
-				break;
-			}
 			String check;
+			Scanner keyboard = new Scanner(System.in);
+			System.out.println("Would you like to return money or borrow money?");
+			//Prompts the user or what they would like to do
+			check = keyboard.nextLine();
+			//If the user chooses to return money, the money is subtracted from the cash amount and debt
+			if(check.equalsIgnoreCase("r")){
+				int returnAsk = 0;
+				System.out.println("Please enter how much you would like to return?");
+				returnAsk = keyboard.nextInt();
+				if(returnAsk <= player.getDebt() && returnAsk >= 0) {
+					player.setDebt(player.getDebt() - returnAsk);
+					player.setMoney(player.getMoney() - returnAsk);
+				}
+				//if you try to return more money than you owe it wont allow you to
+				else if(returnAsk > player.getDebt()){
+					System.out.println("You don't need to return that much!");
+				}
+				//No negative amounts are allowed
+				else{
+					System.out.println("You can't return a negative amount.");
+				}
+
+			}
+			//If the user chooses to borrow, the money is added to cash and the debt is increased
+			else if(check.equalsIgnoreCase("b")){
+				int loanAsk = 0;
+				System.out.println("Please enter how much you would like to borrow");
+				//Prompts user for the amount they would like to borrow
+				loanAsk = keyboard.nextInt();
+				if(loanAsk <= 2*(player.getMoney() - player.getDebt())&& loanAsk >= 0) {
+					player.setDebt(player.getDebt() + loanAsk);
+					player.setMoney(player.getMoney() + loanAsk);
+				}
+				//If the requested money exceeds 2*(cash - debt) then the loan cannot be given
+				else{
+					System.out.println("Sorry you can't be loaned that much");
+					break;
+				}
+			}
+			//Asks the player if they have any other things to do with the load shark
 			System.out.println("Would you like to do any other business? Y / N?");
 			check = keyboard.nextLine();
 			check = keyboard.nextLine();
@@ -46,4 +94,4 @@ public class loanShark {
 			}
 		}
 	}
-}
+}

src/main.java

@@ -2,31 +2,54 @@ public class main {
 
     private Player player = new Player();
 
+    /**
+    * getter method for the Player object player.
+    *
+    * @return returns a copy of the object player
+    */
+    
     public Player getPlayer(){
         Player copy = new Player(player);
         return copy;
     }
 
+    /**
+    * Initializes the Taipan shop with the players stats after the player finishes shopping, it updates the player object and returns it.
+    *
+    * @param shop player object from the main class used to update the shop class
+    */
+    
     public void shop(TaipanShop shop){
         shop.setPlayer(player);
         shop.shop();
         player = shop.getPlayer();
     }
 
+    /**
+    * Initializes the player object with 5 guns or $400 and $5000 debt.
+    *
+    * @param start player object from the main class used to update the start class
+    */
+    
     public void start(Start start){
         start.setPlayer(player);
-        start.intialize();
+        start.initialize();
         player = start.getPlayer();
     }
 
+    /**
+    * Updates main class with player data and starts the game.
+    * The game will only run as long as the player has not retired or has been destroyed.
+     * @param args Just the console for the player to look at.
+    */
     public static void main(String[] args) {
         main main = new main();
         TaipanShop littyShop = new TaipanShop(main.getPlayer());
         Start start = new Start(main.getPlayer());
-
+        
         main.start(start);
         while(!main.getPlayer().getRetire()){
-            main.shop(littyShop);
+            main.shop(littyShop); 
         }
     }
 }