diff --git a/com/csse3200/game/components/player/InventoryComponent.html b/com/csse3200/game/components/player/InventoryComponent.html index 9e0224801..87cf6c9fc 100644 --- a/com/csse3200/game/components/player/InventoryComponent.html +++ b/com/csse3200/game/components/player/InventoryComponent.html @@ -283,8 +283,9 @@

setCapacity

Sets the size of this item component to the newSize provided.
Parameters:
-
newCapacity - - the size to set this item component's capacity to. Must be a positive, non-zero integer. - Throws IllegalArgumentException - if newSize is 1.
+
newCapacity - - the size to set this item component's capacity to. Must be a positive, non-zero integer.
+
Throws:
+
IllegalArgumentException - - if newSize is less than 1.
@@ -295,8 +296,9 @@

setSelected

Sets the currently selected item to the index specified.
Parameters:
-
index - - the index to set the currently selected item to - Throws IllegalArgumentException - if index is not within 0 index this.getSize()
+
index - - the index to set the currently selected item to
+
Throws:
+
IllegalArgumentException - - if index is not within 0 and this.getSize()
@@ -365,8 +367,9 @@

getItemAt

Parameters:
index - - the index being queried.
Returns:
-
the item at index if it exists in the current inventory, null if there is nothing there. - Throws IllegalArgumentException - if the given index is negative or out of bounds.
+
the item at index if it exists in the current inventory, null if there is nothing there.
+
Throws:
+
IllegalArgumentException - - if the given index is negative or out of bounds.
@@ -437,8 +440,9 @@

addItemAt

Parameters:
item - - the item to be added to the Inventory.
-
index - - the index where the item will be inserted. - Throws IllegalArgumentException - if the given index is negative or out of bounds.
+
index - - the index where the item will be inserted.
+
Throws:
+
IllegalArgumentException - - if the given index is negative or out of bounds.
@@ -449,8 +453,9 @@

removeAt

Removes and returns the item from the Inventory at the given index, if it exists.
Parameters:
-
index - - the index where an item will be removed. - Throws IllegalArgumentException - if the given index is negative or out of bounds.
+
index - - the index where an item will be removed.
+
Throws:
+
IllegalArgumentException - - if the given index is negative or out of bounds.