Skip to content

ShopInventoryGrantBridge.md

Latest commit

 

History

History
51 lines (37 loc) · 2.55 KB

ShopInventoryGrantBridge.md

File metadata and controls

51 lines (37 loc) · 2.55 KB

ShopInventoryGrantBridge

Purpose: optional bridge component linking Shop and InventoryComponent. Listens to Shop.OnPurchasedId(itemId) and, for every match in its Mappings table, calls InventoryComponent.AddItemData(...) and fires OnGranted(data, amount).

Available since 8.5.0.

Why not on ShopItemData

Putting _inventoryItem / _inventoryAmount directly on ShopItemData would close an asmdef cycle: Neo.Shop → Neo.Tools.Inventory → Neo.Tools.View → Neo.Tools.Components → Neo.Shop. Inverting the direction here (Neo.Tools.Inventory references Neo.Shop) removes the cycle. The user-facing UX is the same: drop a single component, configure mappings, done.

Setup

  1. Add Shop Inventory Grant Bridge (Add Component > Neoxider > Tools/Inventory > ShopInventoryGrantBridge) on the same GameObject as Shop (or any descendant).
  2. Optionally assign _shop (when null, the bridge searches GetComponentInParent<Shop>() in Awake).
  3. Assign _inventory or enable _useInventorySingleton to use InventoryComponent.Instance.
  4. Fill Mappings:
    • Shop Item Id — stable ShopItemData.Id.
    • Inventory Item — matching InventoryItemData.
    • Amount — units granted per purchase (≥ 1).

When any mapped ShopItemData is purchased (directly or as part of a bundle — Shop raises OnPurchasedId for each item inside BuyBundle), the bridge looks up its mappings and grants the inventory.

Key fields

Field Description
_shop Source of events. When null — auto-found via GetComponentInParent<Shop>() at Awake.
_inventory Target inventory. When null and _useInventorySingleton == true, falls back to InventoryComponent.Instance.
_useInventorySingleton Singleton fallback toggle when _inventory is null.
_mappings List of { Shop Item Id, Inventory Item, Amount }.
OnGranted UnityEvent with arguments (InventoryItemData, int amountAdded).

Code API

ShopInventoryGrantBridge bridge = ...;

bridge.SetShop(shop);
bridge.SetInventory(inventory);
bridge.GrantForShopItemId("sword_basic"); // NoCode-friendly UnityEvent target
bridge.GrantDirect(inventoryItemData, 3); // direct grant (DLC, code paths)
bridge.Mappings.Add(new ShopInventoryGrantBridge.GrantMapping {
    ShopItemId = "season_pass_reward",
    InventoryItem = chest,
    Amount = 1
});

See also