DPB1Class · Game state and actions

Inventory

Provides inventory data and the operations listed below. Related types link to the values this API consumes or returns.

Namespace: DreamPoeBot.Loki.Game

public class Inventory
Reference: DPB1 0.3.29.56Compare the DPB2 reference → Check signatures and usage notes separately; a matching type is not a compatibility guarantee.

Members and overloads

34 declared here

CanFitItem

MethodLink ↗
public bool Inventory.CanFitItem(Vector2i itemSize)

Checks whether it can fit item using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

itemSize

Specifies item size.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItem

MethodLink ↗
public bool Inventory.CanFitItem(Vector2i itemSize, out int col, out int row)

Checks whether it can fit item using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

itemSize

Specifies item size.

col
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target column in the inventory grid.

row
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target row in the inventory grid.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItem

MethodLink ↗
public bool Inventory.CanFitItem(Item item)

Checks whether it can fit item using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

item

Specifies item.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItem

MethodLink ↗
public bool Inventory.CanFitItem(Item item, out int col, out int row)

Checks whether it can fit item using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

item

Specifies item.

col
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target column in the inventory grid.

row
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target row in the inventory grid.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItem

MethodLink ↗
public bool Inventory.CanFitItem(int itemWidth, int itemHeight, out int fcol, out int frow)

Checks whether it can fit item using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

itemWidth
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies item width.

itemHeight
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies item height.

fcol
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives fcol.

frow
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives frow.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItemAt

MethodLink ↗
public bool Inventory.CanFitItemAt(int col, int row, int width, int height, bool allowOverlap, out bool overlapped)

Checks whether it can fit item at using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

col
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target column in the inventory grid.

row
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target row in the inventory grid.

width
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies width.

height
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies height.

allowOverlap
Parameter type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies allow overlap.

overlapped
Parameter type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives overlapped.

Returns: A Boolean result. The member description explains the condition being checked.

CanFitItemSizeAt

MethodLink ↗
public bool Inventory.CanFitItemSizeAt(int itemWidth, int itemHeight, int col, int row)

Checks whether it can fit item size at using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

itemWidth
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies item width.

itemHeight
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies item height.

col
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target column in the inventory grid.

row
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target row in the inventory grid.

Returns: A Boolean result. The member description explains the condition being checked.

CanSlideItemUpOrLeft

MethodLink ↗
public bool Inventory.CanSlideItemUpOrLeft(Item item)

Checks whether it can slide item up or left using the supplied arguments.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

item

Specifies item.

Returns: A Boolean result. The member description explains the condition being checked.

FindItemByFullName

MethodLink ↗
public Item Inventory.FindItemByFullName(string fullName)

Calls FindItemByFullName on Inventory with fullName and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

fullName
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies full name.

Returns: The Item result.

FindItemByName

MethodLink ↗
public Item Inventory.FindItemByName(string name)

Calls FindItemByName on Inventory with name and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

Returns: The Item result.

FindItemByPos

MethodLink ↗
public Item Inventory.FindItemByPos(Vector2i pos)

Calls FindItemByPos on Inventory with pos and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

pos

Specifies pos.

Returns: The Item result.

GetItemAtLocation

MethodLink ↗
public Item Inventory.GetItemAtLocation(Vector2i pos)

Calls GetItemAtLocation on Inventory with pos and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

pos

Specifies pos.

Returns: The Item result.

GetItemAtLocation

MethodLink ↗
public Item Inventory.GetItemAtLocation(int col, int row)

Calls GetItemAtLocation on Inventory with col, row and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

col
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target column in the inventory grid.

row
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The target row in the inventory grid.

Returns: The Item result.

GetItemById

MethodLink ↗
public Item Inventory.GetItemById(int id)

Calls GetItemById on Inventory with id and returns Item. Open the return contract below before using the result.

Return type: Item
Explore Item → members & methods

Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.

Parameters

id
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies id.

Returns: The Item result.

GetItemPlacementGraph

MethodLink ↗
public bool[,] Inventory.GetItemPlacementGraph()

Returns item placement graph.

Return type: bool[,]No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Returns: The bool[,] result.

GetTotalItemQuantityByFullName

MethodLink ↗
public int Inventory.GetTotalItemQuantityByFullName(string fullName)

Calls GetTotalItemQuantityByFullName on Inventory with fullName and returns int. Open the return contract below before using the result.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

fullName
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies full name.

Returns: The int result.

GetTotalItemQuantityByMetadata

MethodLink ↗
public int Inventory.GetTotalItemQuantityByMetadata(string metadata)

Calls GetTotalItemQuantityByMetadata on Inventory with metadata and returns int. Open the return contract below before using the result.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

metadata
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies metadata.

Returns: The int result.

GetTotalItemQuantityByMetadataFlags

MethodLink ↗
public int Inventory.GetTotalItemQuantityByMetadataFlags(MetadataFlags flag)

Calls GetTotalItemQuantityByMetadataFlags on Inventory with flag and returns int. Open the return contract below before using the result.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

flag
Parameter type: MetadataFlags

Specifies flag.

Returns: The int result.

GetTotalItemQuantityByName

MethodLink ↗
public int Inventory.GetTotalItemQuantityByName(string name)

Calls GetTotalItemQuantityByName on Inventory with name and returns int. Open the return contract below before using the result.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

name
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies name.

Returns: The int result.

GetTotalItemStacksByFullName

MethodLink ↗
public int Inventory.GetTotalItemStacksByFullName(string fullName)

Calls GetTotalItemStacksByFullName on Inventory with fullName and returns int. Open the return contract below before using the result.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

fullName
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies full name.

Returns: The int result.

NeedsToMerge

MethodLink ↗
public bool Inventory.NeedsToMerge()

Calls NeedsToMerge on Inventory without arguments and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Returns: A Boolean result. The member description explains the condition being checked.

NextAvailableInventoryPosition

MethodLink ↗
public bool Inventory.NextAvailableInventoryPosition(int w, int h, out Vector2i pos)

Calls NextAvailableInventoryPosition on Inventory with w, h, pos and returns bool. Open the return contract below before using the result.

Return type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

w
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies w.

h
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies h.

pos

Receives pos.

Returns: A Boolean result. The member description explains the condition being checked.

ToString

MethodLink ↗
public override string Inventory.ToString()

Returns a text representation of this value.

Return type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Returns: The string result.

AvailableInventorySquares

PropertyLink ↗
public int Inventory.AvailableInventorySquares { get; }

Reads available inventory squares on Inventory as int. The exact type and accessors are shown below.

Value type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Cols

PropertyLink ↗
public int Inventory.Cols { get; }

Reads cols on Inventory as int. The exact type and accessors are shown below.

Value type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Columns

PropertyLink ↗
public int Inventory.Columns { get; }

Reads columns on Inventory as int. The exact type and accessors are shown below.

Value type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Id

PropertyLink ↗
public int Inventory.Id { get; internal set; }

Reads or assigns id on Inventory as int. The exact type and accessors are shown below.

Value type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

InventorySpacePercent

PropertyLink ↗
public int Inventory.InventorySpacePercent { get; }

Reads inventory space percent on Inventory as int. The exact type and accessors are shown below.

Value type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

IsRequested

PropertyLink ↗
public bool Inventory.IsRequested { get; }

Whether this inventory is requested.

Value type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

DPB1 0.3.29.56 · Reference reviewed 2026-10-30. Descriptions use source summaries where available, otherwise concise signature-based descriptions. Examples illustrate usage; they are not a live-game test.