Skip to main content

Interface IGameInventory

This class provides events for the in-game inventory.

Assembly: Dalamud.dll
View Source
Declaration
public interface IGameInventory

Methods

GetInventoryItems(GameInventoryType)

Gets all item slots of the specified inventory type.

View Source
Declaration
ReadOnlySpan<GameInventoryItem> GetInventoryItems(GameInventoryType type)
Returns

System.ReadOnlySpan<Dalamud.Game.Inventory.GameInventoryItem>: A read-only span of all items in the specified inventory type.

Parameters
TypeNameDescription
Dalamud.Game.Inventory.GameInventoryTypetypeThe type of inventory to get the items for.

Events

InventoryChanged

Event that is fired when the inventory has been changed.

Note that some events, such as Dalamud.Plugin.Services.IGameInventory.ItemAdded, Dalamud.Plugin.Services.IGameInventory.ItemRemoved, and Dalamud.Plugin.Services.IGameInventory.ItemChanged currently is subject to reinterpretation as Dalamud.Plugin.Services.IGameInventory.ItemMoved, Dalamud.Plugin.Services.IGameInventory.ItemMerged, and Dalamud.Plugin.Services.IGameInventory.ItemSplit.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangelogDelegate InventoryChanged
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangelogDelegate

InventoryChangedRaw

Event that is fired when the inventory has been changed, without trying to interpret two inventory slot changes as a move event as appropriate.

In other words, Dalamud.Game.Inventory.GameInventoryEvent.Moved, Dalamud.Game.Inventory.GameInventoryEvent.Merged, and Dalamud.Game.Inventory.GameInventoryEvent.Split currently do not fire in this event.

View Source
Declaration
event IGameInventory.InventoryChangelogDelegate InventoryChangedRaw
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangelogDelegate

ItemAdded

Event that is fired when an item is added to an inventory.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemAdded
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemRemoved

Event that is fired when an item is removed from an inventory.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemRemoved
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemChanged

Event that is fired when an items properties are changed.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemChanged
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemMoved

Event that is fired when an item is moved from one inventory into another.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemMoved
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemSplit

Event that is fired when an item is split from one stack into two.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemSplit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemMerged

Event that is fired when an item is merged from two stacks into one.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate ItemMerged
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate

ItemAddedExplicit

Event that is fired when an item is added to an inventory.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemAddedArgs> ItemAddedExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>

ItemRemovedExplicit

Event that is fired when an item is removed from an inventory.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemRemovedArgs> ItemRemovedExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>

ItemChangedExplicit

Event that is fired when an items properties are changed.

If this event is a part of multi-step event, then this event will not be called.

Use Dalamud.Plugin.Services.IGameInventory.InventoryChangedRaw if you do not want such reinterpretation.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemChangedArgs> ItemChangedExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>

ItemMovedExplicit

Event that is fired when an item is moved from one inventory into another.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemMovedArgs> ItemMovedExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>

ItemSplitExplicit

Event that is fired when an item is split from one stack into two.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemSplitArgs> ItemSplitExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>

ItemMergedExplicit

Event that is fired when an item is merged from two stacks into one.

View Source
Declaration
event IGameInventory.InventoryChangedDelegate<InventoryItemMergedArgs> ItemMergedExplicit
Event Type

Dalamud.Plugin.Services.IGameInventory.InventoryChangedDelegate<T>