Package com.csse3200.game.components.player

Class InventoryComponent

java.lang.Object
com.csse3200.game.components.Component
com.csse3200.game.components.player.InventoryComponent
public class InventoryComponent extends Component
A component intended to be used by the player to track their inventory. Player can switch between weapons and weapons can be updated Can also be used as a more generic component for other entities.

  • Constructor Details

    • InventoryComponent

      public InventoryComponent(WeaponConfigs config)

  • Method Details

    • create

      public void create()
      Description copied from class: Component
      Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.
      Overrides:
      create in class Component

    • update

      public void update()
      Description copied from class: Component
      Called once per frame of the game, and should be used for most component logic. Not called if component is disabled.
      Overrides:
      update in class Component

    • getConfigs

      public WeaponConfigs getConfigs()

    • getEquipped

      public String getEquipped()
      Returns:
      int - the equipped weapon

    • setEquipped

      public void setEquipped(String slot)
      Changes active inventory slot to a specific slot
      Parameters:
      slot - - the weapon to be equipped

    • replaceSlotWithWeapon

      public void replaceSlotWithWeapon(String slot, WeaponType weaponType)
      Replaces the specified slot with a given weapon.
      Parameters:
      slot - the slot to be updated
      weaponType - the weapon type to be placed in the slot

    • getEquippedWeapons

      public ArrayList<WeaponType> getEquippedWeapons()
      Returns the current equipped weapons represented in a hash map

    • placeInSlot

      public void placeInSlot(WeaponType weaponType)

    • changeEquipped

      public void changeEquipped(WeaponType type)
      Updates weapon of the active inventory slot

    • getEquippedType

      public WeaponType getEquippedType()
      Returns the equipped weapon type
      Returns:
      WeaponType - Type of cureently equiped weapon

    • getCurrentAmmo

      public int getCurrentAmmo()
      Get the currently equipped weapons current ammo
      Returns:
      remaining ammo

    • changeEquippedAmmo

      public void changeEquippedAmmo(int ammoChange)
      Changes the amount of ammo in current weapon slot by change (decrease for negative values of ammoChange)
      Parameters:
      ammoChange - - amount to change ammo by

    • getCurrentAmmoUse

      public int getCurrentAmmoUse()
      returns the amount of ammo the currently equipped weapon uses per shot
      Returns:
      amount of ammo use per shot

    • getCurrentMaxAmmo

      public int getCurrentMaxAmmo()
      REturns the amount of max ammo for the current weapon slot
      Returns:

    • getEquippedCooldown

      public int getEquippedCooldown()
      returns the remaining tick cooldown for the currently equipped weapon slot
      Returns:
      amount of ticks before weapon slot can be used again

    • setEquippedCooldown

      public void setEquippedCooldown(int coolDown)
      Sets the cooldown for the currently equipped weapon slot
      Parameters:
      coolDown - - tick duration to set coolDown to