Struct GameInventoryItem

Dalamud wrapper around a ClientStructs InventoryItem.

Assembly: Dalamud.dll

Declaration

public struct GameInventoryItem : IEquatable<GameInventoryItem>

Implements:
System.IEquatable<Dalamud.Game.Inventory.GameInventoryItem>

Properties

IsEmpty

Gets a value indicating whether the this Dalamud.Game.Inventory.GameInventoryItem is empty.

Declaration

public bool IsEmpty { get; }

ContainerType

Gets the container inventory type.

Declaration

public GameInventoryType ContainerType { get; }

InventorySlot

Gets the inventory slot index this item is in.

Declaration

public uint InventorySlot { get; }

ItemId

Gets the item id.

Declaration

public uint ItemId { get; }

BaseItemId

Gets the base item id (without HQ or Collectible offset applied).

Declaration

public uint BaseItemId { get; }

Quantity

Gets the quantity of items in this item stack.

Declaration

public int Quantity { get; }

SpiritbondOrCollectability

Gets the spiritbond or collectability of this item.

Declaration

public uint SpiritbondOrCollectability { get; }

Spiritbond

Gets the spiritbond of this item.

Declaration

[Obsolete("Renamed to SpiritbondOrCollectability", true)]
public uint Spiritbond { get; }

Condition

Gets the repair condition of this item.

Declaration

public uint Condition { get; }

IsHq

Gets a value indicating whether the item is High Quality.

Declaration

public bool IsHq { get; }

IsCompanyCrestApplied

Gets a value indicating whether the item has a company crest applied.

Declaration

public bool IsCompanyCrestApplied { get; }

IsRelic

Gets a value indicating whether the item is a relic.

Declaration

public bool IsRelic { get; }

IsCollectable

Gets a value indicating whether the is a collectable.

Declaration

public bool IsCollectable { get; }

Materia

Gets the array of materia types.

Declaration

public ReadOnlySpan<ushort> Materia { get; }

MateriaGrade

Gets the array of materia grades.

Declaration

public ReadOnlySpan<byte> MateriaGrade { get; }

MateriaEntries

Gets a list of materia entries for this item. Exists as a user-friendly interface to Dalamud.Game.Inventory.GameInventoryItem.Materia and Dalamud.Game.Inventory.GameInventoryItem.MateriaGrade.

Declaration

public IReadOnlyList<MateriaEntry> MateriaEntries { get; }

Address

Gets the address of native inventory item in the game.

Can be 0 if this instance of Dalamud.Game.Inventory.GameInventoryItem does not point to a valid set of container type and slot.

Note that this instance of Dalamud.Game.Inventory.GameInventoryItem can be a snapshot; it may not necessarily match the data you can query from the game using this address value.

Declaration

public nint Address { get; }

Stains

Gets the color used for this item.

Declaration

public ReadOnlySpan<byte> Stains { get; }

GlamourId

Gets the glamour id for this item.

Declaration

public uint GlamourId { get; }

Methods

Equals(in GameInventoryItem)

Indicates whether the current object is equal to another object of the same type.

Declaration

public readonly bool Equals(in GameInventoryItem other)

Returns

System.Boolean: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false.

Parameters

Type	Name	Description
Dalamud.Game.Inventory.GameInventoryItem	other	An object to compare with this object.

Equals(object)

Declaration

public override bool Equals(object obj)

Returns

System.Boolean

Parameters

Type	Name
System.Object	obj

GetHashCode()

Declaration

public override int GetHashCode()

Returns

System.Int32

ToString()

Declaration

public override string ToString()

Returns

System.String

Implements

• System.IEquatable<Dalamud.Game.Inventory.GameInventoryItem>