cleanup shop window/item #2623

WeylonSantana · 2025-02-24T04:18:44Z

resolves #2558

assets in AscensionGameDev/Intersect-Assets#62

Shop Window inherits from Window
ShopItem inheriting from image
code reduction and cleaning in general

Functions delegated correctly now:

The Window only serves as a container, with no context logic when right-clicking on the shop item
Shop item dealing with the context menu, since it is the one that is clicked and not the window as before

I recommend looking at the files directly in the ide, github is showing everything strange

working as it should so far

1740370540_Intersect_Client.mp4

lodicolo

The updated shop window should not use the shop.png background image anymore and should be able to regenerate its own JSON from scratch, and the assets PR should just be uploading a freshly regenerated JSON (and one that doesn't change after being generated and the client reopened).

If you need examples to look at:

MainMenuWindow
CreditsWindow
DebugWindow
SettingsWindow
LoginWindow
RegistrationWindow
CharacterSelectionWindow
HotbarWindow (though this isn't a real window)
EventWindow (also not a real window)
InputBox / AlertWindow

WeylonSantana · 2025-02-26T04:20:22Z

I believe I have done everything I said, it is like this now

1740543182_Intersect_Client.mp4

lodicolo · 2025-02-26T09:26:37Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs


-    public ImagePanel Container;
+        MinimumSize = new Point(34, 35);


This isn't right, shop items should be square (34, 34)

The JSON will need regeneration after fixing this

lodicolo · 2025-02-26T09:28:11Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs


-    private bool mIsEquipped;
+        // Generate our context menu with basic options.
+        _contextMenu = new ContextMenu(Interface.CurrentInterface.Root, "ShopContextMenu")


Can you add a // TODO: Refactor so shop only has 1 context menu shared between all items here

lodicolo · 2025-02-26T09:29:27Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs


-    //Drag/Drop References
-    private ShopWindow mShopWindow;
+        if (Globals.GameShop == default || Globals.GameShop.SellingItems.Count == 0)


if (Globals.GameShop is not { SellingItems.Count: >0 } gameShop)

lodicolo · 2025-02-26T09:29:42Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs


-    public ImagePanel Pnl;
+        if (!ItemBase.TryGet(Globals.GameShop.SellingItems[_mySlot].CostItemId, out var item))


Globals.GameShop -> gameShop

lodicolo · 2025-02-26T09:29:45Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

-        mShopWindow = shopWindow;
-        mMySlot = index;
-    }
+        if (Globals.GameShop.SellingItems[_mySlot].Item != default)


Globals.GameShop -> gameShop

lodicolo · 2025-02-26T09:44:37Z

Intersect.Client.Core/Interface/Game/Shop/ShopWindow.cs

+            var xPosition = column * itemWidthWithPadding + xPadding;
+            var yPosition = row * itemHeightWithPadding + yPadding;


xPadding -> slotContainer.Margin.Left
yPadding -> slotContainer.Margin.Top

item*WithPadding should be replaced with the outerSize stuff already mentioned

lodicolo · 2025-02-26T09:49:54Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

+        // Generate our context menu with basic options.
+        _contextMenu = new ContextMenu(Interface.CurrentInterface.Root, "ShopContextMenu")
+        {
+            IsHidden = true,


Add ItemFontSize = 10, and ItemFont = GameContentManager.Current.GetFont(name: "sourcesansproblack"),

lodicolo · 2025-02-26T09:50:11Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

+        var font = GameContentManager.Current.GetFont(name: "sourcesansproblack");
+        if (font != default)
+        {
+            _contextMenu.SetItemFont(font, 10);
+        }


Remove this entirely

lodicolo · 2025-02-26T09:59:47Z

Intersect.Client.Framework/Gwen/Control/Menu.cs

+    public void SetItemFont(IFont font, int fontSize)
+    {
+        mItemFont = font;
+        _itemFontSize = fontSize;
+        mItemFontInfo = $"{font.Name},{fontSize}";
+        UpdateItemStyles();
+    }


No, rename mItemFont to _itemFont, delete mItemFontInfo, add private string? _itemFontName;

Add:

public string? ItemFontName { get => _itemFontName; set => SetItemFont(GameContentManager.Current.GetFont(_itemFontName), _itemFontName); } public IFont? ItemFont { get => _itemFont; set => SetItemFont(value, value?.Name); } private void SetItemFont(IFont? itemFont, string? itemFontName) { var oldValue = _itemFont; _itemFont = itemFont; _itemFontName = itemFontName; if (itemFont != oldValue) { OnFontChanged(this, itemFont, oldValue); } } protected virtual void OnFontChanged(Base sender, IFont? newFont, IFont? oldFont) { UpdateItemStyles(); } public int ItemFontSize { get => _itemFontSize; set { if (value == _itemFontSize) { return; } var oldValue = _itemFontSize; _itemFontSize = value; OnFontSizeChanged(this, value, oldValue); } } protected virtual void OnFontSizeChanged(Base sender, int newSize, int oldSize) { UpdateItemStyles(); }

For loading JSON

replace the start with

public override void LoadJson(JToken token, bool isRoot = default) { base.LoadJson(token, isRoot); if (token is not JObject obj) { return; }

and replace the "ItemFont" section with

string? itemFontName = null; int? itemFontSize = null; if (obj.TryGetValue(nameof(ItemFont), out var tokenItemFont) && tokenItemFont is JValue { Type: JTokenType.String } valueItemFont) { var stringItemFont = valueItemFont.Value<string>()?.Trim(); if (!string.IsNullOrWhiteSpace(stringItemFont)) { var parts = stringItemFont.Split(','); itemFontName = parts.FirstOrDefault(); if (parts.Length > 1 && int.TryParse(parts[1], out var size)) { itemFontSize = size; } } } if (obj.TryGetValue(nameof(ItemFontName), out var tokenItemFontName) && tokenItemFontName is JValue { Type: JTokenType.String } valueItemFontName) { itemFontName = valueItemFontName.Value<string>(); } if (obj.TryGetValue(nameof(ItemFontSize), out var tokenItemFontSize) && tokenItemFontSize is JValue { Type: JTokenType.Integer } valueItemFontSize) { itemFontSize = valueItemFontSize.Value<int>(); } if (itemFontSize.HasValue) { ItemFontSize = itemFontSize.Value; } itemFontName = itemFontName?.Trim(); if (!string.IsNullOrWhiteSpace(itemFontName)) { ItemFontName = itemFontName; }

For saving JSON remove the "ItemFont" line and use

serializedProperties.Add(nameof(ItemFontName), ItemFontName); serializedProperties.Add(nameof(ItemFontSize), ItemFontSize);

lodicolo · 2025-02-26T10:11:26Z

Intersect.Client.Framework/Gwen/ControlInternal/ScrollBarBar.cs

+    public override JObject FixJson(JObject json)
+    {
+        json.Remove("HoverSound");
+        json.Remove("MouseUpSound");
+        json.Remove("MouseDownSound");
+        return base.FixJson(json);
+    }


I don't think this is needed? What would be adding those keys to begin with?

lodicolo · 2025-02-26T16:00:19Z

Intersect.Client.Core/Interface/Game/GameInterface.cs

@@ -585,7 +583,7 @@ public bool CloseAllWindows()
            closedWindows = true;
        }

-        if (mShopWindow != null && mShopWindow.IsVisible())
+        if (mShopWindow != null && !mShopWindow.IsHidden)


Use IsVisibleInTree

lodicolo · 2025-02-26T16:00:36Z

Intersect.Client.Core/Interface/Game/GameInterface.cs

@@ -392,7 +390,7 @@ public void Update(TimeSpan elapsed, TimeSpan total)
            GameMenu.OpenInventory();
        }

-        if (mShopWindow != null && (!mShopWindow.IsVisible() || mShouldCloseShop))
+        if (mShopWindow != null && (mShopWindow.IsHidden || mShouldCloseShop))


Use !IsVisibleInTree

lodicolo · 2025-02-26T16:01:07Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

+        // TODO: Refactor so shop only has 1 context menu shared between all items
+        _contextMenu = new ContextMenu(Interface.CurrentInterface.Root, "ShopContextMenu")
+        {
+            IsHidden = true,


IsVisibleInParent = false,

lodicolo · 2025-02-26T16:03:48Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

-            );
-        }
+        _contextMenu.UserData = slot;
+        _contextMenu.SizeToChildren();


This isn't necessary, it's built into the context menu's Open (via OnOpen())

lodicolo · 2025-02-26T16:04:48Z

Intersect.Client.Core/Interface/Game/Shop/ShopItem.cs

+        if (Globals.GameShop?.SellingItems[slot] == default)
        {
            return;
        }

-        if (Globals.InputManager.IsMouseButtonDown(MouseButton.Left))
+        if (!ItemBase.TryGet(Globals.GameShop.SellingItems[slot].ItemId, out var item))


Globals.GameShop changes need to be done in this method too, also cache the SellingItems[slot] array access instead of duplicating it

lodicolo · 2025-02-26T16:09:12Z

Intersect.Client.Framework/Gwen/ControlInternal/ScrollBarBar.cs

+        SetSound(ButtonSoundState.Hover, "octave-tap-resonant.wav");
+        SetSound(ButtonSoundState.MouseDown, "octave-tap-warm.wav");
+        SetSound(ButtonSoundState.MouseUp, "octave-tap-warm.wav");


When I said to add this here I meant specifically the setting of sounds because Dragger shouldn't have default sounds like Button, ScrollbarBar, and SliderBar do.

I didn't mean to add the infrastructure for sound into this class too, since Dragger had the infrastructure that stuff should be cleaned up. _stateSoundNames and _ignoreMouseUpSoundsUntil (and the methods that use them) should be in Dragger just like they are in Button.

Only the SetSound(...); calls that are right here should stay in this class.

lodicolo · 2025-02-26T16:10:11Z

Intersect.Client.Framework/Gwen/Control/ImagePanel.cs

@@ -181,7 +181,7 @@ protected override void Dispose(bool disposing)

        serializedProperties.Add(nameof(Texture), TextureFilename);
        serializedProperties.Add(nameof(TextureNinePatchMargin), TextureNinePatchMargin?.ToString());
-        serializedProperties.Add("HoverSound", mHoverSound);
+        serializedProperties.Add("HoverSound", HoverSound);


nameof(HoverSound) instead of the string

lodicolo · 2025-02-26T16:10:18Z

Intersect.Client.Framework/Gwen/Control/ImagePanel.cs

@@ -19,7 +19,7 @@ public partial class ImagePanel : Base
    private readonly float[] _uv;

    //Sound Effects
-    protected string mHoverSound;
+    public string HoverSound;


{ get; set; }

lodicolo · 2025-02-26T16:11:05Z

Intersect.Client.Framework/Gwen/Control/ImagePanel.cs

Also update Left/RightMouseClickSounds to be loaded/saved (and they should be { get; set; } like HoverSound is

lodicolo · 2025-02-26T21:41:34Z

Intersect.Client.Framework/Gwen/Control/ImagePanel.cs

+        if (obj[nameof(HoverSound)] is JValue { Type: JTokenType.String } hoverSound &&
+            hoverSound.Value<string>()?.Trim() is { Length: > 0 })
        {
-            mHoverSound = (string) obj["HoverSound"];
+            HoverSound = hoverSound?.Value<string>();
        }


I think this should be slightly different to make sure what we compare is what we set, specifically:

if (obj[nameof(HoverSound)] is JValue { Type: JTokenType.String } tokenHoverSound && tokenHoverSound.Value<string>()?.Trim() is { Length: > 0 } hoverSound) { HoverSound = hoverSound; }

lodicolo · 2025-02-26T21:41:50Z

Intersect.Client.Framework/Gwen/Control/ImagePanel.cs

+        if (obj[nameof(LeftMouseClickSound)] is JValue { Type: JTokenType.String } leftMouseClickSound &&
+            leftMouseClickSound.Value<string>()?.Trim() is { Length: > 0 })
        {
-            mLeftMouseClickSound = (string) obj["LeftMouseClickSound"];
+            LeftMouseClickSound = leftMouseClickSound?.Value<string>();
        }

-        if (obj["RightMouseClickSound"] != null)
+        if (obj[nameof(RightMouseClickSound)] is JValue { Type: JTokenType.String } rightMouseClickSound &&
+            rightMouseClickSound.Value<string>()?.Trim() is { Length: > 0 })
        {
-            mRightMouseClickSound = (string) obj["RightMouseClickSound"];
+            RightMouseClickSound = rightMouseClickSound?.Value<string>();


Do the same thing as I suggested with HoverSound

WeylonSantana mentioned this pull request Feb 24, 2025

update shop window title position AscensionGameDev/Intersect-Assets#62

Merged

WeylonSantana changed the title ~~clean up shop window/item~~ cleanup shop window/item Feb 24, 2025

WeylonSantana force-pushed the fix-2558 branch from 564360a to 13d8cff Compare February 25, 2025 19:54

WeylonSantana requested a review from lodicolo February 25, 2025 19:55

lodicolo requested changes Feb 25, 2025

View reviewed changes

lodicolo requested changes Feb 26, 2025

View reviewed changes

WeylonSantana force-pushed the fix-2558 branch from c2ff7a7 to 2b8ac40 Compare February 26, 2025 21:26

lodicolo requested changes Feb 26, 2025

View reviewed changes

WeylonSantana force-pushed the fix-2558 branch from 7d67782 to 6fdb3b1 Compare February 26, 2025 21:57

WeylonSantana added 19 commits February 26, 2025 18:14

clean up shop window/item

7266251

update shop window to the new pattern

c685010

first load min/max size before validate bounds

8c4930e

explicit hover sound to hard code images hover sound value

635692b

add set item font to hardcode default font value for context menu

ea9a993

add _stateSoundNames to scrollbar bar

0fa2221

generating default shop item

79f53e4

more refactor and cleaning

6366edc

cleanup image panel sounds handling

0f7a460

using isVisibleInTree/Parent instead IsHidden

299315b

remove redundant info to context menu

82733f4

transfer sound logic from child to parent

02348b0

fix close all windows

791c64f

expose left/right click sound

5ec9e21

better check for image panel sound load

fb84d3f

fix KeyNotFoundException for sound handling

7dd3eaa

remove unused set item font

f141fad

fix: broken others context menus

25ff5cc

fix property acess

96ac3ce

lodicolo force-pushed the fix-2558 branch from e8552a3 to 96ac3ce Compare February 26, 2025 23:14

lodicolo merged commit a5f748e into AscensionGameDev:main Feb 26, 2025
1 check passed

lodicolo deleted the fix-2558 branch February 26, 2025 23:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cleanup shop window/item #2623

cleanup shop window/item #2623

WeylonSantana commented Feb 24, 2025 •

edited

Loading

lodicolo left a comment

WeylonSantana commented Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025

lodicolo Feb 26, 2025


		public ImagePanel Container;
		MinimumSize = new Point(34, 35);


		public ImagePanel Pnl;
		if (!ItemBase.TryGet(Globals.GameShop.SellingItems[_mySlot].CostItemId, out var item))

		var xPosition = column * itemWidthWithPadding + xPadding;
		var yPosition = row * itemHeightWithPadding + yPadding;

cleanup shop window/item #2623

cleanup shop window/item #2623

Conversation

WeylonSantana commented Feb 24, 2025 • edited Loading

lodicolo left a comment

Choose a reason for hiding this comment

WeylonSantana commented Feb 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WeylonSantana commented Feb 24, 2025 •

edited

Loading