UnequipItem

[pavlicekdominik]

Function: UnequipItem

Purpose: To remove an item from an equipment slot and flag it as unequipped in the inventory.

Inputs:

• TargetSlotName: FName: The name of the equipment slot from which the item should be removed.

Returns:

• bool: True if the item is successfully unequipped, False otherwise.

Description:

Removes the equipped flag from an item in a designated slot. If the slot is empty, the function will simply return false, indicating that there was nothing to unequip.

Pseudocode:

Function UnequipItem(TargetSlotName: FName) -> bool:

    // Check if the target slot exists in the equipment system
    If not DoesSlotExist(TargetSlotName):
        Return false

    // Retrieve the target equipment slot based on its name
    TargetSlot = GetEquipmentSlot(SearchCriteria with SlotName = TargetSlotName)

    // Check if the slot is empty
    If TargetSlot.ItemSlot.ItemInstance is nullptr:
        Return false

    // Retrieve the item from the slot
    ItemToUnequip = TargetSlot.ItemSlot.ItemInstance

    // Remove the 'Equipped' flag from the item
    ItemToUnequip.RemoveItemFlag("Equipped")

    // Clear the item from the equipment slot
    TargetSlot.ItemSlot.ItemInstance = nullptr

    // Return true to indicate the successful unequipping of the item
    Broadcast Event: "ItemUnequipped" with parameters (ItemToUnequip, TargetSlotName)
    Return true

End Function