Inventool Documentation
  • Inventool Documentation
  • đŸ•šī¸Quick Start
    • Installation
    • Start Creating
  • 💡General
    • Running the Demo
    • Menu Options
    • UI Updates
    • UI Customizations
      • uGUI
      • UI Toolkit
    • Custom Item Drops
  • 🎓Tutorials
    • Demo Walkthrough
  • âœī¸Editors
    • Inventool
      • Inventory
      • Equipment
      • Items
      • Currencies
      • Crafting
      • Dismantling
      • Enchanting
      • Stats
        • Stat IDs
        • Attributes
      • Settings
    • Item Type Manager
    • Localization Editor
    • Stats Editor
    • Merchants
      • Shopkeeper
      • Craftsman
      • Enchanter
    • Storage
    • Loot
      • Loot Box
      • Item Pouch
      • Currency Pouch
    • Components
      • Initializer
      • UI
        • uGUI
          • Inventool Window
          • Split UI
            • Inventory Window UGUI
            • Equipment Window UGUI
            • Key Items Window UGUI
            • Crafting Window UGUI
            • Enchanting Window UGUI
            • Storage Window UGUI
            • Shop Window UGUI
            • Selector UGUI
          • Action Menu UGUI
          • Hover Details UGUI
          • Confirm Prompt UGUI
          • Quantity Prompt UGUI
          • Character Viewer Element UGUI
        • UI Toolkit
          • Inventool Window
          • Split UI
            • Inventory Window
            • Equipment Window
            • Key Items Window
            • Crafting Window
            • Enchanting Window
            • Storage Window
            • Shop Window
          • Action Menu
          • Hover Details
          • Confirm Prompt
          • Quantity Prompt
        • Character Viewer
      • Overworld Merchant
      • Storage Keeper
      • Item Drop
      • Item Spawner
      • Input
        • Cross Input Support
        • Cross Input Support UGUI
          • Target Selectable
  • 📄Scripting API
    • Initialization
    • Inventory
    • Equipment
      • Equipment Slot
    • Items
      • Item
      • Item Type
      • Item Stack
      • Item Drop
      • Item Spawner
      • Loot Box
      • Item Pouch
    • Currencies
      • Currency Identity
      • Currency
        • Value
      • Currency Pouch
    • Crafting
      • Craft
      • Crafter
    • Enchanting
      • Enchantment
    • Stats
      • Stat Identity
      • Attribute
      • Stat
        • Stat Value
          • Value
        • Effectiveness
      • Stat Profile
    • Storing
      • Storage
      • Storage Keeper
    • Settings
    • Merchants
      • Shopkeeper
      • Craftsman
      • Enchanter
      • Overworld Merchant
    • UI
      • uGUI
        • Inventool Window UGUI
        • Split UI
          • Draggable Window UGUI
            • Inventory Window UGUI
            • Equipment Window UGUI
            • Key Items Window UGUI
            • Crafting Window UGUI
            • Enchanting Window UGUI
            • Storage Window UGUI
            • Shop Window UGUI
          • Selector UGUI
        • Action Menu UGUI
        • Hover Details UGUI
        • Confirm Prompt UGUI
        • Quantity Prompt UGUI
        • Draggable Element UGUI
          • Equipment Slot Element UGUI
          • Item Slot Element UGUI
          • Item Stack Element UGUI
        • Action Menu Option UGUI
        • Currency Element UGUI
        • Inventory Filter UGUI
        • Inventory Slot UGUI
        • Key Item Element UGUI
        • Shop Item Element UGUI
        • Storage Currency Element UGUI
        • Stat Element UGUI
      • UI Toolkit
        • Inventool Window
        • Split UI
          • Draggable Window
            • Inventory Window
            • Equipment Window
            • Key Items Window
            • Crafting Window
            • Enchanting Window
            • Storage Window
            • Shop Window
        • Action Menu
        • Hover Details
        • Confirm Prompt
        • Quantity Prompt
        • Item Elements
          • Item Stack Element
          • Equipment Slot Element
          • Item Slot Element
          • Shop Item Element
      • Action Menu Option
      • Character Viewer
    • Events
    • Sounds
    • Saving & Loading
      • Inventory & Equipment
      • Storage
    • Input
      • Cross Input Support
      • Cross Input Support UGUI
    • Localization
      • Localization Settings
      • Localizer
  • đŸ› ī¸Support
    • Getting Help
  • 📚Changelogs
    • Latest Releases
    • Future Plans
  • ⭐Rate Me?
Powered by GitBook
On this page
  • Fields & Properties
  • Active Instance
  • Opening & Closing
  • Open
  • Close
  • Toggle
  1. Scripting API
  2. UI
  3. uGUI
  4. Split UI
  5. Draggable Window UGUI

Inventory Window UGUI

Scripting with the InventoryWindowUGUI class.

The InventoryWindowUGUI class is the Inventool's inventory window.

Fields & Properties

Name
Description
Type
Access

itemStackElementPrefab

The item stack element prefab. This is the object placed over slots.

ItemStackElementUGUI

protected

inventorySlotPrefab

The empty inventory slot prefab.

InventorySlotUGUI

protected

inventoryFilterPrefab

The inventory filter prefab.

InventoryFilterUGUI

protected

currencyElementPrefab

The currency display element prefab.

CurrencyElementUGUI

protected

closeButton

The close button.

Button

protected

pageLeftButton

The inventory's previous page button.

Button

protected

pageRightButton

The inventory's next page button.

Button

protected

inventoryTitleLabel

The inventory title element.

Label

protected

weightLabel

The inventory weight amount label.

Label

protected

pagesLabel

The inventory pages label.

Label

protected

filterTitleLabel

The inventory filter title label.

Label

protected

weightArea

The inventory weight area.

GameObject

protected

currenciesContainer

The RectTransform that contains currency UI elements.

RectTransform

protected

inventoryArea

The inventory area.

RectTransform

protected

gridLayoutGroup

The grid layout group for the inventory slots.

GridLayoutGroup

protected

inventoryContentFitter

The inventory content size fitter.

ContentSizeFitter

protected

filterScroll

The inventory filter scroll.

ScrollRect

protected

inventoryScroll

The inventory scroll rect.

ScrollRect

protected

inventoryCanvasGroup

The inventory canvas group for hiding purposes during reload.

CanvasGroup

protected

pagesArea

The area for the pagination text and buttons.

RectTransform

protected

inventoryScrollbar

The inventory scrollbar.

Scrollbar

protected

currencyElements

Loaded currency elements.

List<CurrencyElementUGUI>

protected

inventoryFilters

A list of inventory filters.

List<InventoryFilterUGUI>

protected

selectedInventoryFilter

The currently selected filter.

InventoryFilterUGUI

protected

loadedInventorySlots

A list of all loaded inventory slots.

List<InventorySlotUGUI>

protected

loadedItemElements

A list of all loaded item UI elements.

Dictionary<ItemStack, ItemStackElementUGUI>

protected

inventoryRequiresReload

If the inventory requires reloading.

bool

protected

originalInventoryAreaHeight

The original height of the inventory area.

float

protected

Loaded

If all UI elements have been loaded.

bool

public

Active Instance

You can get the active InventoryWindowUGUI instance with InventoryWindowUGUI.Instance. Ensure there's an instance of it in your scene before using this field.

Opening & Closing

Open

Call the Open method when the player wants to open their inventory.

InventoryWindowUGUI.Instance.Open();

Close

Close simply closes the window.

InventoryWindowUGUI.Instance.Close();

Toggle

Optionally, you can use Toggle to open or close the window.

InventoryWindowUGUI.Instance.Toggle();
PreviousDraggable Window UGUINextEquipment Window UGUI

Last updated 2 months ago

📄