#88 Inventory system

DOCUMENTATION.md

@@ -2,13 +2,13 @@
 
 - [Disclaimer](#disclaimer)
 - [Cards](#cards)
- - [Effects](#effects)
- - [Status](#status)
+ - [Effects](#effects)
+ - [Status](#status)
 - [Entity](#entity)
 - [Map](#map)
- - [Rooms](#rooms)
- - [Events](#events)
- - [Light mechanic](#light-mechanic)
+ - [Rooms](#rooms)
+ - [Events](#events)
+ - [Light mechanic](#light-mechanic)
 - [Animation](#animation)
 
 # Disclaimer

InventoryComponents/InventoryConsumablesComponent.gd

@@ -1,7 +1,9 @@
 class_name InventoryConsumablesComponent
 
-##The held_consumables array has slots with the value null so that we can [br]
-## have item in for exsample slot 1 and 3 but nothing in slot 2
+## Inventory Component resposible for Consumables [br]
+## There is a set amount of slots the player has and each of them can have one item, if any items are given to the player when all slots are full then they dissapear
+
+## The held_consumables array has slots with the value null so that we can have item in for example slot 1 and 3 but nothing in slot 2
 var _held_consumables : Array[Consumable]
 var _max_consumable_number : int = 4
 
@@ -85,3 +87,10 @@ func get_max_consumable_amount() -> int:
 
 func get_held_consumables() -> Array[Consumable]:
  return _held_consumables
+
+func has_open_slots() -> bool:
+ for consumable_slot in _held_consumables:
+ if(consumable_slot == null):
+ return true
+
+ return false

InventoryComponents/InventoryGoldCompoent.gd

@@ -1,5 +1,7 @@
 class_name InventoryGoldComponent
 
+##Inventory component respisible for gold
+
 var _current_gold : int = 0
 signal gold_changed(new_amount : int)
 

InventoryComponents/InventoryHUD/InventoryHUD.gd

@@ -1,12 +1,13 @@
 extends Control
 
+## Simple script to deal with the temporary InventoryHUD
+
 @onready var _gold_text : Label = $CanvasLayer/ColorRect/GoldText
 @onready var _torch_text : Label = $CanvasLayer/ColorRect/TorchText
 @onready var _relic_component : InventoryHUDRelicComponent = $CanvasLayer/ColorRect/Relics
 @onready var _debug_buttons : Control = $CanvasLayer/Buttons
 
-## sets the inventory values to display the items in the player inventory [br]
-## as well as conects to signals so that they update as the inventory does
+## sets the inventory values to display the items in the player inventory as well as conects to signals so that they update as the inventory does
 func _ready() -> void:
  update_gold_text(InventoryManager.gold_component.get_gold_amount())
  update_torch_text(InventoryManager.torch_component.get_torch_amount())

InventoryComponents/InventoryHUD/InventoryHUDConsumableSlotComponent.gd

@@ -11,6 +11,7 @@ var consumable_slot : PackedScene = preload("res://InventoryComponents/Inventory
 func _ready() -> void:
  _prepare_consumable_slots()
 
+## simple function called in _ready which connects the necessary signals
 func _prepare_consumable_slots()-> void:
  InventoryManager.consumable_component.consumable_max_number_changed.connect(_set_consumable_slots)
  InventoryManager.consumable_component.held_consumable_changed.connect(set_consumable_in_consumable_slot)

InventoryComponents/InventoryHUD/InventoryHUDRelicDisplay.gd

@@ -1,5 +1,7 @@
 extends Control
 class_name InventoryHUDRelicDisplay
+
+## an item instanced for the iventoryHUD
 
 @export var textureRect : TextureRect
 

InventoryComponents/InventoryHUD/InventoryHudRelicComponent.gd

@@ -1,6 +1,8 @@
 extends Control
 class_name InventoryHUDRelicComponent
 
+## HUD component which deals with the relics
+
 var relic_display : PackedScene = preload("res://InventoryComponents/InventoryHUD/relic_display.tscn")
 var relic_display_array : Array[InventoryHUDRelicDisplay]
 @onready var relic_start_pos : Node = $StartPos
@@ -19,6 +21,8 @@ func add_relic_to_display(relic : Relic, is_added : bool) -> void:
  _relic_array.erase(relic)
  update_relic_display()
 
+
+## updateds the shown relics 
 func update_relic_display() -> void:
  for relic_display_instance in relic_display_array:
  relic_display_instance.queue_free()

InventoryComponents/InventoryRelicComponent.gd

@@ -1,5 +1,7 @@
 class_name InventoryRelicComponent
 
+## Inventory component responisble fro relics
+
 var _held_relics : Array[Relic]
 
 #is_added bool will be true if you're adding the relic and false if you're removing it

InventoryComponents/InventoryTorchComponent.gd

@@ -1,5 +1,7 @@
 class_name InventoryTorchComponent
 
+## Inventory component responsible for torches
+
 var _torch_amount : int = 0
 signal torches_changed(new_amount : int)