CUIItemUpgrade implementation (anvil UI) (#417)

* UIItemUpgrade: Item upgrade process completed

* UIItemUpgrade: Animation loop refactored

* CUIItemUpgrade: Refactored behaviour like 1299 Client

* Refactored IsSlotCompatible function

* CUIItemupgrade Header updated

* Merge branch 'master' of https://github.com/Mervandeli/KnightOnline

* resolved conflicts

* Right click behavior added

* minor updates

* IsSlotCompatible updated

* minor review changes applied

* Some reviews solved

* other reviews and ui close problem solved

* ItemCount handled outside render

* Upgrade scroll slot and ItemUpgrade slot seperated

* Removed Unnecessary functions

* UI elements handled on load

* Fixed before commit problem

* Removed deleteiconskill function and defined magic numbers

* Removed deleteiconskill from header

* SetupIconarea used in other functions

* Upgradearea rightclick behavior fixed

* Fixed some reviews

* text ids added text_resource.h  and MsgRecv_ItemUpgrade updated

* orher reviews and icon move bug fixed

* Update RestoreInventoryFromBackup logic and rename to UpdateInventory

* last countable item updateinventory problem fixed

* Parent class changed N3UIWndBase to N3UIBase

* Other reviews solved

* Refactored handle functions

* Move Icon poblem fixed

* Removed some functions

* Countable Items problem fixed

* GetWndDistrict updated and Using member reduced

* Countable icons moving like original 1299 client

* ReceiveMessage updated

* Minor update

* Reduced class members

* Used N3_VERIFY_UI_COMPONENT method for Success and Fail UI

* Minor update

* UIItemUpgrade.cpp error fix

* Update UIItemUpgrade.cpp

Remove unintended empty statement in UIItemUpgrade.cpp

* Cleanup pass to knock out low hanging fruit

* Add e_ItemEffect2, fix check

* Tidy up MsgRecv_ObjectEvent()

* Add __IconItemSkill::IsStackable() helper

* Minor cleanup

* IsTrina method removed and Consumable item check added

* SetVisibleWithNoSound updated and SetVisible method added

* SetVisibleWithNoSound updated

* Removed Open method

* CleanArea method removed

* Fix: Reset m_pSelectedItem when associated item is freed to prevent invalid pointer access

* ShowItemCount removed and Countable labels logic moved to render

* UIMsgBoxOkCancel added

* Include untracked files missed in last commit

* Fix missing delete in MsgRecv_ItemUpgrade

* Resolve conflicts

* untrack submodules

* deps/db-modules removed

* Fix errors

* merge master

* merge master

* Fix errors

* Minor update

* Fix slot errors

* Formatter pass

* Add to WarFare/CMakeLists.txt

* Restore forward declaration

* This branch is implemented, disable lint checker for next one

* Address detected clang-tidy issues

* clang-tidy warning fixes

* Fix stack split error

* run clang-format

* Merge branch 'master' into itemupgrade

Conflicts:
	src/Client/WarFare/GameDef.h
	src/Client/WarFare/IconItemSkill.h

* Update e_ItemUpgradeResult naming in tests as well

* Remove redundant and nonsense definitions

* Rename for consistency

* Use 'requirement' consistently instead of 'material'

* GetWndDistrict(): Be explicit to indicate how this works

As-is there's no indication of what this method actually does; it isn't clear that
the cursor position is fetched for this. From the outside it looks like it serves
a completely different role than it actually does.

So we'll be explicit; that way it's clear that it's fetching the district for the
given cursor position.

* We don't really need a helper for this

At least, not implemented at this level - and then it would need to be more flexible.
... for effectively 2 lines of code.

* Move icon creation helper to __IconItemSkill

* Consistent free logic

delete() is legally allowed to pass nullptr. It's a no-op.
We don't need to constantly be checking for this.

* Rename GetItemFromInv() -> CopyInventoryItems()

This is more explicit in what it does.
Typically many UIs move icons around rather than copy (and are named as such; ItemMoveFromInvToThis).
'Get' is not very specific.

* Fix mem leaks in CopyInventoryItems() + HandleInventoryIconRightClick()

* Use int8_t for consistency

* Separate item being dragged from tooltip item

This ensures it's correct for the right frame and isn't unintentionally influenced between frames,
e.g. when dragging over the top of another icon.

Also fix bugs caused by implicit copies; we should just explicitly clone these as needed, rather than
this though.

* Consistently block item interactions during an upgrade

* Always allocate item for drag, refactor packet handling

Rather than have iffy logic having to constantly try and figure out if it's a copy (to free) or a reference (to absolutely not free, but restore),
we just always allocate a copy regardless.

Additionally, we refactor packet handling to modify the inventory and then just reload the inventory state.
This is simpler than trying to update 2 states (which it wasn't even doing, so they were easily out of state, especially with stack size changes).

Finally, remove MouseProc() - this logic is redundant. It's handled by UIMSG_ICON_DOWN already.

* Remove drag-specific stack hackery, modify on drag instead

(and consequently when restoring)

* Restore MouseProc(), remove UIMSG_ICON_DOWN implementation

At this level, MouseProc() can trigger a little more generously, at least
when we indicate work has been done (UI_MOUSEPROC_DONESOMETHING).

This allows things to act a little smoother as it still behaves when dragged outside the UI.

* Req items should show a stack size of 0 in the inventory when in use

* Don't allow upgrade slot items to be moved

* __IconItemSkill: Add Clone() and block implicit copy behaviour

It's unclear what exactly we want to copy here; we might want the icon, we might not.

Implicit copy behaviour by default would copy the pointer rather than allocate a new instance,
and then it wouldn't be clear which parent it should be assigned to.

To be very clear about what we want, we explicitly add Clone() to fully clone the entire thing.

Anything else can be handled manually, but it should be rare.

* Revert GetUVRect() changes for now

Don't want to touch tools. Too much of a hassle with clang-tidy for now.
Really need to go over tools with clang-tidy so this is not an issue.

* Remove redundant CreateIcon() call

* Refactor to be slightly more sensible/checked

* Sort requirement items in the client

Fix sort order to be consistent with official; this should be descending, not ascending

* These are used now

* These are signed

* Be consistent

* This is no longer used

* Restore official behaviour for single stack req items

Officially this will act as a 'move' and only show up in the requirement list.
Since we're just cloning, to simulate this, we just selectively hide/show the icon as appropriate.

* Only enforce upgrade UI item changes when visible

* Right-clicks should explicitly handle behaviour based on slot

* Ensure items are reset consistently after upgrades

On successful upgrades, on the next assignment, it should reset.
When it burns, we shouldn't bother preserving the slot position as
this item is deleted already, and it just blocks us from adding another.

Also make this consistent across right-clicks and left-clicks.

---------

Co-authored-by: twostars <i.am.twostars@gmail.com>

Author: Mervandeli

src/Client/WarFare/CMakeLists.txt

@@ -89,6 +89,8 @@ set(WARFARE_SCENE_INGAME_UI_SOURCES
   UIInn.h
   UIInventory.cpp
   UIInventory.h
+  UIItemUpgrade.cpp
+  UIItemUpgrade.h
   UIKnightsOperation.cpp
   UIKnightsOperation.h
   UILevelGuide.cpp

src/Client/WarFare/GameDef.h

@@ -382,15 +382,20 @@ enum e_PlugPosition : int8_t
 
 enum e_ItemAttrib : int8_t
 {
-	ITEM_ATTRIB_GENERAL         = 0,
-	ITEM_ATTRIB_MAGIC           = 1,
-	ITEM_ATTRIB_LAIR            = 2,
-	ITEM_ATTRIB_CRAFT           = 3,
-	ITEM_ATTRIB_UNIQUE          = 4,
-	ITEM_ATTRIB_UPGRADE         = 5,
-	ITEM_ATTRIB_UNIQUE_REVERSE  = 11,
-	ITEM_ATTRIB_UPGRADE_REVERSE = 12,
-	ITEM_ATTRIB_UNKNOWN         = -1
+	ITEM_ATTRIB_GENERAL = 0,
+	ITEM_ATTRIB_MAGIC   = 1,
+	ITEM_ATTRIB_LAIR    = 2,
+	ITEM_ATTRIB_CRAFT   = 3,
+	ITEM_ATTRIB_UNIQUE  = 4,
+	ITEM_ATTRIB_UPGRADE = 5,
+	ITEM_ATTRIB_UNKNOWN = -1
+};
+
+enum e_ItemEffect2 : uint8_t
+{
+	ITEM_EFFECT2_RING_UPGRADE_REQ = 253,
+	ITEM_EFFECT2_RENTAL_SCROLL    = 254,
+	ITEM_EFFECT2_ITEM_UPGRADE_REQ = 255
 };
 
 enum e_ItemGrade : uint8_t

src/Client/WarFare/GameProcMain.cpp

@@ -52,6 +52,7 @@
 #include "UIQuestTalk.h"
 #include "UIDead.h"
 #include "UIUpgradeSelect.h"
+#include "UIItemUpgrade.h"
 #include "UILevelGuide.h"
 #include "UIMsgBoxOkCancel.h"
 
@@ -139,6 +140,7 @@ CGameProcMain::CGameProcMain()     // r기본 생성자.. 각 변수의 역활
 	m_pUIQuestTalk          = new CUIQuestTalk();
 	m_pUIDead               = new CUIDead();
 	m_pUIUpgradeSelect      = new CUIUpgradeSelect();
+	m_pUIItemUpgrade        = new CUIItemUpgrade();
 	m_pUILevelGuide         = new CUILevelGuide();
 
 	m_pSubProcPerTrade      = new CSubProcPerTrade();
@@ -189,6 +191,7 @@ CGameProcMain::~CGameProcMain()
 	delete m_pUIQuestTalk;
 	delete m_pUIDead;
 	delete m_pUIUpgradeSelect;
+	delete m_pUIItemUpgrade;
 	delete m_pUILevelGuide;
 
 	delete m_pSubProcPerTrade;
@@ -242,6 +245,7 @@ void CGameProcMain::ReleaseUIs()
 	m_pUIInn->Release();
 	m_pUICreateClanName->Release();
 	m_pUIUpgradeSelect->Release();
+	m_pUIItemUpgrade->Release();
 	m_pUILevelGuide->Release();
 
 	CN3UIBase::DestroyTooltip();
@@ -4221,6 +4225,14 @@ void CGameProcMain::InitUI()
 	m_pUIUpgradeSelect->SetState(UI_STATE_COMMON_NONE);
 	m_pUIUpgradeSelect->SetStyle(m_pUIUpgradeSelect->GetStyle() | UISTYLE_USER_MOVE_HIDE | UISTYLE_SHOW_ME_ALONE);
 
+	m_pUIItemUpgrade->Init(s_pUIMgr);
+	m_pUIItemUpgrade->LoadFromFile(pTbl->szItemUpgrade);
+	m_pUIItemUpgrade->SetVisibleWithNoSound(false);
+	rc = m_pUIItemUpgrade->GetRegion();
+	m_pUIItemUpgrade->SetPos(iW - (rc.right - rc.left), 10);
+	m_pUIItemUpgrade->SetState(UI_STATE_COMMON_NONE);
+	m_pUIItemUpgrade->SetStyle(UISTYLE_USER_MOVE_HIDE | UISTYLE_SHOW_ME_ALONE);
+
 	//ui level guide
 	m_pUILevelGuide->Init(s_pUIMgr);
 	m_pUILevelGuide->LoadFromFile(pTbl->szLvlGuide);
@@ -5778,6 +5790,15 @@ void CGameProcMain::MsgRecv_ObjectEvent(Packet& pkt)
 		}
 		break;
 
+		case OBJECT_TYPE_ANVIL:
+		{
+			/*
+			if (iResult == 0) // anvil object failed animation	
+			if (iResult == 1) // anvil object succeeded animation
+			*/
+		}
+		break;
+
 		default:
 			__ASSERT(0, "Unknown Object Event");
 	}
@@ -8001,14 +8022,12 @@ void CGameProcMain::MsgRecv_ItemUpgrade(Packet& pkt)
 			}
 			break;
 
-		// NOLINTNEXTLINE(bugprone-branch-clone)
 		case ITEM_UPGRADE_PROCESS:
-#if 0 // TODO
 			if (m_pUIItemUpgrade != nullptr)
 				m_pUIItemUpgrade->MsgRecv_ItemUpgrade(pkt);
-#endif
 			break;
 
+		// NOLINTNEXTLINE(bugprone-branch-clone)
 		case ITEM_UPGRADE_ACCESSORIES:
 #if 0 // TODO
 			if (m_pUIRingUpgrade != nullptr)

src/Client/WarFare/GameProcMain.h

@@ -64,6 +64,7 @@ class CGameProcMain : public CGameProcedure
 	class CUITradeBBSEditDlg* m_pUITradeBBSEdit;      // 상거래 게시물 설명
 
 	class CUIUpgradeSelect* m_pUIUpgradeSelect;
+	class CUIItemUpgrade* m_pUIItemUpgrade;
 	class CUILevelGuide* m_pUILevelGuide;
 
 	class CN3Shape* m_pTargetSymbol;              // 플레이어가 타겟으로 잡은 캐릭터의 위치위에 그리면 된다..

src/Client/WarFare/IconItemSkill.cpp

@@ -1,15 +1,17 @@
 #include "StdAfx.h"
 #include "IconItemSkill.h"
 #include "GameDef.h"
+#include "N3UIIcon.h"
+#include "N3UIWndBase.h"
 
 __IconItemSkill::__IconItemSkill()
 {
+	pUIIcon     = nullptr;
 	pItemBasic  = nullptr;
 	pItemExt    = nullptr;
 	iCount      = 0;
 	iDurability = 0;
 	pSkill      = nullptr;
-	pUIIcon     = nullptr;
 }
 
 int __IconItemSkill::GetItemID() const
@@ -55,3 +57,49 @@ int __IconItemSkill::GetSellPrice(bool bHasPremium /*= false*/) const
 
 	return iSellPrice;
 }
+
+bool __IconItemSkill::IsStackable() const
+{
+	if (pItemBasic == nullptr)
+		return false;
+
+	return pItemBasic->byContable == UIITEM_TYPE_COUNTABLE || pItemBasic->byContable == UIITEM_TYPE_COUNTABLE_SMALL;
+}
+
+void __IconItemSkill::CreateIcon(const std::string& szFN, CN3UIBase* pParent, uint32_t dwStyle, float fUVAspect)
+{
+	szIconFN = szFN;
+
+	delete pUIIcon;
+	pUIIcon = new CN3UIIcon();
+	pUIIcon->Init(pParent);
+
+	pUIIcon->SetTex(szFN);
+	pUIIcon->SetUVRect(0, 0, fUVAspect, fUVAspect);
+	pUIIcon->SetStyle(dwStyle);
+	pUIIcon->SetVisible(true);
+}
+
+__IconItemSkill* __IconItemSkill::Clone(CN3UIBase* pParent)
+{
+	__IconItemSkill* spItemNew = new __IconItemSkill();
+
+	spItemNew->szIconFN        = szIconFN;
+	spItemNew->pItemBasic      = pItemBasic;
+	spItemNew->pItemExt        = pItemExt;
+	spItemNew->pSkill          = pSkill;
+	spItemNew->iCount          = iCount;
+	spItemNew->iDurability     = iDurability;
+
+	if (pUIIcon != nullptr)
+	{
+		spItemNew->pUIIcon = new CN3UIIcon();
+		spItemNew->pUIIcon->Init(pParent);
+		spItemNew->pUIIcon->SetTex(szIconFN);
+		spItemNew->pUIIcon->SetUVRect(*pUIIcon->GetUVRect());
+		spItemNew->pUIIcon->SetStyle(pUIIcon->GetStyle());
+		spItemNew->pUIIcon->SetVisible(pUIIcon->IsVisible());
+	}
+
+	return spItemNew;
+}

src/Client/WarFare/IconItemSkill.h

@@ -3,9 +3,12 @@
 
 #pragma once
 
+#include <N3Base/N3UIDef.h>
+
 #include <cstdint>
 #include <string>
 
+class CN3UIBase;
 class CN3UIIcon;
 struct __TABLE_ITEM_BASIC;
 struct __TABLE_ITEM_EXT;
@@ -29,9 +32,14 @@ struct __IconItemSkill
 	};
 
 	__IconItemSkill();
+	__IconItemSkill(const __IconItemSkill& src) = delete;
 	int GetItemID() const;
 	int GetBuyPrice() const;
 	int GetSellPrice(bool bHasPremium = false) const;
+	bool IsStackable() const;
+	void CreateIcon(const std::string& szFN, CN3UIBase* pParent, uint32_t dwStyle = UISTYLE_ICON_ITEM | UISTYLE_ICON_CERTIFICATION_NEED,
+		float fUVAspect = 45.0f / 64.0f);
+	__IconItemSkill* Clone(CN3UIBase* pParent);
 };
 
 #endif // CLIENT_WARFARE_ICONITEMSKILL_H

src/Client/WarFare/N3UIWndBase.h

@@ -34,17 +34,20 @@ enum e_UIWND : uint8_t
 // District Info..
 enum e_UIWND_DISTRICT : uint8_t
 {
-	UIWND_DISTRICT_INVENTORY_SLOT = 0, // Slot district of Inventory Wnd..
-	UIWND_DISTRICT_INVENTORY_INV,      // Inv district of Inventory Wnd..
-	UIWND_DISTRICT_TRADE_NPC,          // Transaction district of Transaction Wnd of Npc..
-	UIWND_DISTRICT_PER_TRADE_MY,       // My Transaction district of Per Transaction Wnd..
-	UIWND_DISTRICT_PER_TRADE_OTHER,    // Other Transaction district of Per Transaction Wnd..
-	UIWND_DISTRICT_DROPITEM,           // Dropitem district of Drop item wnd..
-	UIWND_DISTRICT_SKILL_TREE,         // Skillicon district of Skill icon wnd..
-	UIWND_DISTRICT_SKILL_HOTKEY,       // Skillicon district of Hotkey icon wnd..
-	UIWND_DISTRICT_TRADE_MY,           // Npc 와의 거래에서 내 영역..
-	UIWND_DISTRICT_PER_TRADE_INV,      // Inv District of Per Trade Wnd ..
-	UIWND_DISTRICT_UNKNOWN,            // District Unknown..
+	UIWND_DISTRICT_INVENTORY_SLOT = 0,  // Slot district of Inventory Wnd..
+	UIWND_DISTRICT_INVENTORY_INV,       // Inv district of Inventory Wnd..
+	UIWND_DISTRICT_TRADE_NPC,           // Transaction district of Transaction Wnd of Npc..
+	UIWND_DISTRICT_PER_TRADE_MY,        // My Transaction district of Per Transaction Wnd..
+	UIWND_DISTRICT_PER_TRADE_OTHER,     // Other Transaction district of Per Transaction Wnd..
+	UIWND_DISTRICT_DROPITEM,            // Dropitem district of Drop item wnd..
+	UIWND_DISTRICT_SKILL_TREE,          // Skillicon district of Skill icon wnd..
+	UIWND_DISTRICT_SKILL_HOTKEY,        // Skillicon district of Hotkey icon wnd..
+	UIWND_DISTRICT_TRADE_MY,            // Npc 와의 거래에서 내 영역..
+	UIWND_DISTRICT_PER_TRADE_INV,       // Inv District of Per Trade Wnd ..
+	UIWND_DISTRICT_UPGRADE_INV,         // Upgrade Inv
+	UIWND_DISTRICT_UPGRADE_SLOT,        // Upgrade material slot
+	UIWND_DISTRICT_UPGRADE_RESULT_SLOT, // Upgrade result slot
+	UIWND_DISTRICT_UNKNOWN,             // District Unknown..
 };
 
 enum e_UIIconState : uint8_t

src/Client/WarFare/UIImageTooltipDlg.cpp

@@ -916,9 +916,7 @@ void CUIImageTooltipDlg::CalcTooltipStringNumAndWriteImpl(__IconItemSkill* spIte
 		std::string szReduce;
 		if (spItem->pItemExt->siNeedStrength < 0)
 		{
-			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE_REVERSE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE_REVERSE)
+			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE)
 				szReduce = fmt::format_text_resource(IDS_TOOLTIP_REDUCE);
 		}
 
@@ -943,9 +941,7 @@ void CUIImageTooltipDlg::CalcTooltipStringNumAndWriteImpl(__IconItemSkill* spIte
 		std::string szReduce;
 		if (spItem->pItemExt->siNeedStamina < 0)
 		{
-			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE_REVERSE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE_REVERSE)
+			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE)
 				szReduce = fmt::format_text_resource(IDS_TOOLTIP_REDUCE);
 		}
 
@@ -970,9 +966,7 @@ void CUIImageTooltipDlg::CalcTooltipStringNumAndWriteImpl(__IconItemSkill* spIte
 		std::string szReduce;
 		if (spItem->pItemExt->siNeedDexterity < 0)
 		{
-			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE_REVERSE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE_REVERSE)
+			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE)
 				szReduce = fmt::format_text_resource(IDS_TOOLTIP_REDUCE);
 		}
 
@@ -997,9 +991,7 @@ void CUIImageTooltipDlg::CalcTooltipStringNumAndWriteImpl(__IconItemSkill* spIte
 		std::string szReduce;
 		if (spItem->pItemExt->siNeedInteli < 0)
 		{
-			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE_REVERSE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE_REVERSE)
+			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE)
 				szReduce = fmt::format_text_resource(IDS_TOOLTIP_REDUCE);
 		}
 
@@ -1024,9 +1016,7 @@ void CUIImageTooltipDlg::CalcTooltipStringNumAndWriteImpl(__IconItemSkill* spIte
 		std::string szReduce;
 		if (spItem->pItemExt->siNeedMagicAttack < 0)
 		{
-			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE_REVERSE
-				|| spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE_REVERSE)
+			if (spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UNIQUE || spItem->pItemExt->byMagicOrRare == ITEM_ATTRIB_UPGRADE)
 				szReduce = fmt::format_text_resource(IDS_TOOLTIP_REDUCE);
 		}