Skip to content

Commit

Permalink
Deploying to gh-pages from @ 85d6caa 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@MiniSoda17
MiniSoda17 committed Oct 3, 2023
1 parent 6a25414 commit a04a238
Show file tree
Hide file tree
Showing 15 changed files with 472 additions and 126 deletions.
77 changes: 41 additions & 36 deletions allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -845,73 +845,78 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Trajects a projectile from an entity towards the enemy entities</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/screens/TurretSelectionScreen.html" title="class in com.csse3200.game.screens">TurretSelectionScreen</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/ui/UIComponent.html" title="class in com.csse3200.game.ui">UIComponent</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A generic component for rendering onto the ui.</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/waves/Tuple.html" title="class in com.csse3200.game.components.tasks.waves">Tuple</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class represent a tuple of a String and an int which when used represent
a mob name and health.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tower/UpgradableStatsComponent.html" title="class in com.csse3200.game.components.tower">UpgradableStatsComponent</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/input/UpgradeUIComponent.html" title="class in com.csse3200.game.input">UpgradeUIComponent</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/screens/TurretSelectionScreen.html" title="class in com.csse3200.game.screens">TurretSelectionScreen</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.html" title="class in com.csse3200.game.files">UserSettings</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/ui/UIComponent.html" title="class in com.csse3200.game.ui">UIComponent</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Reading, Writing, and applying user settings in the game.</div>
<div class="block">A generic component for rendering onto the ui.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.DisplaySettings.html" title="class in com.csse3200.game.files">UserSettings.DisplaySettings</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tower/UpgradableStatsComponent.html" title="class in com.csse3200.game.components.tower">UpgradableStatsComponent</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/input/UpgradeUIComponent.html" title="class in com.csse3200.game.input">UpgradeUIComponent</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.html" title="class in com.csse3200.game.files">UserSettings</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Stores chosen display settings.</div>
<div class="block">Reading, Writing, and applying user settings in the game.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.Settings.html" title="class in com.csse3200.game.files">UserSettings.Settings</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.DisplaySettings.html" title="class in com.csse3200.game.files">UserSettings.DisplaySettings</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Stores game settings, can be serialised/deserialised.</div>
<div class="block">Stores chosen display settings.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/utils/math/Vector2Utils.html" title="class in com.csse3200.game.utils.math">Vector2Utils</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/files/UserSettings.Settings.html" title="class in com.csse3200.game.files">UserSettings.Settings</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Contains additional utility constants and functions for common Vector2 operations.</div>
<div class="block">Stores game settings, can be serialised/deserialised.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/WaitTask.html" title="class in com.csse3200.game.components.tasks">WaitTask</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/utils/math/Vector2Utils.html" title="class in com.csse3200.game.utils.math">Vector2Utils</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Task that does nothing other than waiting for a given time.</div>
<div class="block">Contains additional utility constants and functions for common Vector2 operations.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/configs/WallTowerConfig.html" title="class in com.csse3200.game.entities.configs">WallTowerConfig</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/WaitTask.html" title="class in com.csse3200.game.components.tasks">WaitTask</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Defines a basic set of properties stored in entities config files to be loaded by Entity Factories.</div>
<div class="block">Task that does nothing other than waiting for a given time.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WaterQueenAnimationController.html" title="class in com.csse3200.game.components.npc">WaterQueenAnimationController</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/configs/WallTowerConfig.html" title="class in com.csse3200.game.entities.configs">WallTowerConfig</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Defines a basic set of properties stored in entities config files to be loaded by Entity Factories.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WaterQueenAnimationController.html" title="class in com.csse3200.game.components.npc">WaterQueenAnimationController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class listens to events relevant to a ghost entity's state and plays the animation when one
of the events is triggered.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WaterSlimeAnimationController.html" title="class in com.csse3200.game.components.npc">WaterSlimeAnimationController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WaterSlimeAnimationController.html" title="class in com.csse3200.game.components.npc">WaterSlimeAnimationController</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class listens to events relevant to a ghost entity's state and plays the animation when one
of the events is triggered.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/waves/WaveClass.html" title="class in com.csse3200.game.components.tasks.waves">WaveClass</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/factories/WaveFactory.html" title="class in com.csse3200.game.entities.factories">WaveFactory</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/waves/WaveClass.html" title="class in com.csse3200.game.components.tasks.waves">WaveClass</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/services/WaveService.html" title="class in com.csse3200.game.services">WaveService</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/factories/WaveFactory.html" title="class in com.csse3200.game.entities.factories">WaveFactory</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/waves/WaveTask.html" title="class in com.csse3200.game.components.tasks.waves">WaveTask</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/services/WaveService.html" title="class in com.csse3200.game.services">WaveService</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/csse3200/game/entities/Weapon.html" title="interface in com.csse3200.game.entities">Weapon</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/tasks/waves/WaveTask.html" title="class in com.csse3200.game.components.tasks.waves">WaveTask</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/csse3200/game/entities/Weapon.html" title="interface in com.csse3200.game.entities">Weapon</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Projectiles and Melee are to implement this interface to be used as weapons</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/configs/WeaponTowerConfig.html" title="class in com.csse3200.game.entities.configs">WeaponTowerConfig</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/entities/configs/WeaponTowerConfig.html" title="class in com.csse3200.game.entities.configs">WeaponTowerConfig</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Defines a basic set of properties stored in entities config files to be loaded by Entity Factories.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WizardAnimationController.html" title="class in com.csse3200.game.components.npc">WizardAnimationController</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/WizardAnimationController.html" title="class in com.csse3200.game.components.npc">WizardAnimationController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class listens to events relevant to a ghost entity's state and plays the animation when one
of the events is triggered.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/XenoAnimationController.html" title="class in com.csse3200.game.components.npc">XenoAnimationController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/csse3200/game/components/npc/XenoAnimationController.html" title="class in com.csse3200.game.components.npc">XenoAnimationController</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class listens to events relevant to a ghost entity's state and plays the animation when one
of the events is triggered.</div>
</div>
Expand Down
11 changes: 7 additions & 4 deletions com/csse3200/game/areas/ForestGameArea.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,9 @@ <h2>Method Summary</h2>
<div class="block">Dispose of all internal entities in the area</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#spawnMob(java.lang.String,com.badlogic.gdx.math.GridPoint2)" class="member-name-link">spawnMob</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;entity,
com.badlogic.gdx.math.GridPoint2&nbsp;randomPos)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#spawnMob(java.lang.String,com.badlogic.gdx.math.GridPoint2,int)" class="member-name-link">spawnMob</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;entity,
com.badlogic.gdx.math.GridPoint2&nbsp;randomPos,
int&nbsp;health)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Spawn an entity on the map.</div>
</div>
Expand Down Expand Up @@ -189,15 +190,17 @@ <h3>create</h3>
</section>
</li>
<li>
<section class="detail" id="spawnMob(java.lang.String,com.badlogic.gdx.math.GridPoint2)">
<section class="detail" id="spawnMob(java.lang.String,com.badlogic.gdx.math.GridPoint2,int)">
<h3>spawnMob</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">spawnMob</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;entity,
com.badlogic.gdx.math.GridPoint2&nbsp;randomPos)</span></div>
com.badlogic.gdx.math.GridPoint2&nbsp;randomPos,
int&nbsp;health)</span></div>
<div class="block">Spawn an entity on the map. Is called during a wave. Add cases here for each mob type</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>entity</code> - mob to be spawned</dd>
<dd><code>randomPos</code> - position to be spawned at</dd>
<dd><code>health</code> - health of the mob</dd>
</dl>
</section>
</li>
Expand Down
17 changes: 15 additions & 2 deletions com/csse3200/game/components/CombatStatsComponent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,14 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the entity's fullHealth variable.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="../entities/Melee.html" title="class in com.csse3200.game.entities">Melee</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withinRange(com.csse3200.game.entities.Entity)" class="member-name-link">withinRange</a><wbr>(<a href="../entities/Entity.html" title="class in com.csse3200.game.entities">Entity</a>&nbsp;target)</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateHealth(int)" class="member-name-link">updateHealth</a><wbr>(int&nbsp;setTo)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Update the health of the enemy.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="../entities/Melee.html" title="class in com.csse3200.game.entities">Melee</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withinRange(com.csse3200.game.entities.Entity)" class="member-name-link">withinRange</a><wbr>(<a href="../entities/Entity.html" title="class in com.csse3200.game.entities">Entity</a>&nbsp;target)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if the target is within range of any of the close range attacks.</div>
</div>
</div>
Expand Down Expand Up @@ -420,6 +425,14 @@ <h3>getState</h3>
lowHealth: below 33% of full health</div>
</section>
</li>
<li>
<section class="detail" id="updateHealth(int)">
<h3>updateHealth</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">updateHealth</span><wbr><span class="parameters">(int&nbsp;setTo)</span></div>
<div class="block">Update the health of the enemy.
Used in WaveFactory to increase difficulty of enemies</div>
</section>
</li>
</ul>
</section>
</li>
Expand Down
Loading

0 comments on commit a04a238

Please sign in to comment.