Inventory Pro Add-On Documentation
  • Welcome to Inventory Pro Add-On for FPS Engine!
  • BEFORE WE START
    • Early Considerations
    • Add-On Compatibility
    • List of Tutorials
  • GETTING STARTED
    • 01. Basic Set-Up
    • 02. Roadmap
  • CONTENT
    • 03. Content
      • 03.1 CRAFTING
        • Recipe_SO
          • Ingredient
        • CraftingButton
        • CraftingProcess
        • CraftingUI
        • CraftingBench
        • IngredientUIIcon
      • 03.2 FAV MENU
        • FavItemSlot
        • FavItemsMenu
          • FavItemReference
      • 03.3 INTERACTABLES
        • InventoryItemPickeable
      • 03.4 INVENTORY
        • InventoryGridData_SO
        • InventoryProManager
        • GridGenerator
        • InventorySlot
        • SlotData
        • InventoryProManagerInputActions
      • 03.5 ITEMS
        • AppleItem_SO
        • EnergyDrinkItem_SO
      • 03.6 OTHERS
        • 03.6.1 TRADE HUB
          • TradeButton
          • TradeUI
          • TradeHub
        • Chest
        • ExamineItem
      • 03.7 SHOP
        • PurchasableItem
        • Shop
          • ShopItemData
        • ShopUI
        • ShopButton
      • 03.8 UI TOOLKIT
        • ContextMenu
        • HighlightInteractions
        • Padding
        • TooltipManager
    • 04. Shared Content for Add-Ons
  • HOW TO USE & GUIDES
    • Uninstalling the Add-On: Fixing Errors
    • Creating, Updating & Deleting Recipes
    • Inventory Designer: Creating, Updating & Deleting Inventory Grid Data
    • Working with Crafting Benches
    • Working with Chests
    • Working with Shops
    • Working with Purchasable Items
    • Working with Item Examination
    • Favorite Pinned Items Menu Considerations
    • Inventory, Hotbar & Chests Considerations
    • Tetris Inventory Considerations
    • Weapons & Ammo from the Inventory
    • Custom Item_SOs
    • Adding a New Inventory
  • FAQ
    • FAQ
  • SUPPORT
    • Support
Powered by GitBook
On this page
  • Getters | FavItemsMenu.cs
  • Functions | FavItemsMenu.cs
  1. CONTENT
  2. 03. Content
  3. 03.2 FAV MENU

FavItemsMenu

FavItemsMenu manages the creation and navigation of the Radial Menu. It also handles adding, referencing, and removing FavItemReferences for each FavItemSlot.

PreviousFavItemSlotNextFavItemReference

Last updated 27 days ago

  • radialMenuSize: Amount of items that can be pinned to favorite.

  • buttonPrefab: to instantiate at the radial menu.

  • menuRadius: Defines the size of the Menu in the UI

  • highlightText: When hovering an Item, this text displays its Name

  • highlightIcon: When hovering an Item, this text displays its Icon

Getters | FavItemsMenu.cs

RadialMenuSize

Amount of in the Menu.

Functions | FavItemsMenu.cs

CreateMenu()

Generates and Populates the Radial Menu

ContainsItemReferenceInPinned(FavItemReference favItemReference)

Check if any existing FavItemReference in the already pinned favorites matches the passed favItemReference

AddItemReferenceToPinned(FavItemReference favItemReference)

Add a new reference ( passed favItemReference ) to the Menu.

UnpinFromFavMenu(InventorySlot slot)

Unpins an Inventory Slot from the favoritesList

UnpinBasedOnIndex(int slotIndex)

Unpins an Inventory Slot from the favoritesList based on the index it occupies in favoritesList

Highlight(FavItemReference favItemReference)

Highlight a Favorite Item and display its Icon & Name

Unhighlight(int slotIndex)

Unhighlights a Favorite Item.

FavItemSlot
FavItemSlots

FavItemReference