DPB2Class · Game state and actions

InventoryControlWrapper

Work with a specific inventory grid, including selecting and picking up items. Use the local item identifier from that grid.

Namespace: DreamPoeBot.Loki.Game

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

Members and overloads

52 declared here

OpenDisplayNote

MethodLink ↗
public OpenDisplayNoteResult InventoryControlWrapper.OpenDisplayNote(bool actuallyUse = true)

Opens display note using the supplied arguments.

Return type: OpenDisplayNoteResult
Explore OpenDisplayNoteResult → members & methods

Named values for open display note result. Select a value when an API accepts or returns OpenDisplayNoteResult.

Parameters

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

Not read by this overload in the reviewed source. Do not rely on this argument to change its behavior.

Returns: The OpenDisplayNoteResult result.

OpenDisplayNote

MethodLink ↗
public OpenDisplayNoteResult InventoryControlWrapper.OpenDisplayNote(int localId, bool actuallyUse = true)

Opens display note using the supplied arguments.

Return type: OpenDisplayNoteResult
Explore OpenDisplayNoteResult → members & methods

Named values for open display note result. Select a value when an API accepts or returns OpenDisplayNoteResult.

Parameters

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

The item's identifier within its owning inventory; do not substitute a grid position.

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

Not read by this overload in the reviewed source. Do not rely on this argument to change its behavior.

Returns: The OpenDisplayNoteResult result.

Pickup

MethodLink ↗
public PickupResult InventoryControlWrapper.Pickup(bool actuallyPickup = true)

Picks up the selected item onto the cursor. The item must belong to this inventory grid. Check the returned result before continuing.

Return type: PickupResult
Explore PickupResult → members & methods

Named values for pickup result. Select a value when an API accepts or returns PickupResult.

Parameters

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

Not read by this overload in the reviewed source. Do not rely on this argument to change its behavior.

Returns: The PickupResult result.

Public DPB2 0.4.5.103 extends the SkillGemPanelUi.InventoryControl binding to removable main gems. Pickup requires G open and an empty cursor; FastMove requires I and G open. Placement uses a cut skill, Spirit or meta gem: col is the zero-based main slot and row is zero; the no-coordinate overload chooses the first empty main slot. Supports use EquipSkillGem/UnequipSkillGem instead; innate weapon skills are not removable gems. Validation-only flags send no input for this binding. None is not confirmation: reread the cursor and inventories before continuing, without automatic retry.

Pickup

MethodLink ↗
public PickupResult InventoryControlWrapper.Pickup(int localId, bool actuallyPickup = true)

Pick up the item with this local inventory ID. In SkillGemPanelUi.InventoryControl, targets the main gem (not its supports), scrolls it into view and left-clicks once. Requires G open, hooks enabled and an empty cursor. actuallyPickup=false performs validation only for this panel binding. None is dispatch/validation success, not server confirmation.

Return type: PickupResult
Explore PickupResult → members & methods

Named values for pickup result. Select a value when an API accepts or returns PickupResult.

Parameters

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

The item's identifier within its owning inventory; do not substitute a grid position.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The PickupResult result.

Public DPB2 0.4.5.103 extends the SkillGemPanelUi.InventoryControl binding to removable main gems. Pickup requires G open and an empty cursor; FastMove requires I and G open. Placement uses a cut skill, Spirit or meta gem: col is the zero-based main slot and row is zero; the no-coordinate overload chooses the first empty main slot. Supports use EquipSkillGem/UnequipSkillGem instead; innate weapon skills are not removable gems. Validation-only flags send no input for this binding. None is not confirmation: reread the cursor and inventories before continuing, without automatic retry.

PlaceCursorInto

MethodLink ↗
public PlaceCursorIntoResult InventoryControlWrapper.PlaceCursorInto(bool allowOverlap = false, bool actuallyPlace = true)

Place into a single-slot control. In the G panel binding, selects the first available empty main gem slot instead; never automatically replaces an equipped gem. actuallyPlace=false validates without input for this binding.

Return type: PlaceCursorIntoResult
Explore PlaceCursorIntoResult → members & methods

Named values for place cursor into result. Select a value when an API accepts or returns PlaceCursorIntoResult.

Parameters

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

Specifies allow overlap. Optional; the default is shown in the signature.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The PlaceCursorIntoResult result.

Public DPB2 0.4.5.103 extends the SkillGemPanelUi.InventoryControl binding to removable main gems. Pickup requires G open and an empty cursor; FastMove requires I and G open. Placement uses a cut skill, Spirit or meta gem: col is the zero-based main slot and row is zero; the no-coordinate overload chooses the first empty main slot. Supports use EquipSkillGem/UnequipSkillGem instead; innate weapon skills are not removable gems. Validation-only flags send no input for this binding. None is not confirmation: reread the cursor and inventories before continuing, without automatic retry.

PlaceCursorInto

MethodLink ↗
public PlaceCursorIntoResult InventoryControlWrapper.PlaceCursorInto(int col, int row, bool allowOverlap = false, bool actuallyPlace = true)

Place the cursor item at zero-based inventory coordinates. In the G panel binding, col is the main gem slot and row must be zero. Requires a physical cut main gem, G open and hooks enabled; allowOverlap permits an explicit occupied-slot swap. actuallyPlace=false validates without input for this binding. None is not server confirmation. For a gem's inner sockets use EquipSkillGem(hostLocalId, socketIndex) instead.

Return type: PlaceCursorIntoResult
Explore PlaceCursorIntoResult → members & methods

Named values for place cursor into result. Select a value when an API accepts or returns PlaceCursorIntoResult.

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.

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

Specifies allow overlap. Optional; the default is shown in the signature.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The PlaceCursorIntoResult result.

Public DPB2 0.4.5.103 extends the SkillGemPanelUi.InventoryControl binding to removable main gems. Pickup requires G open and an empty cursor; FastMove requires I and G open. Placement uses a cut skill, Spirit or meta gem: col is the zero-based main slot and row is zero; the no-coordinate overload chooses the first empty main slot. Supports use EquipSkillGem/UnequipSkillGem instead; innate weapon skills are not removable gems. Validation-only flags send no input for this binding. None is not confirmation: reread the cursor and inventories before continuing, without automatic retry.

SetInventory

MethodLink ↗
public void InventoryControlWrapper.SetInventory(Inventory inv)

Calls SetInventory on InventoryControlWrapper with inv. This overload has no return value.

Return type: voidNo return value.

Parameters

inv

Specifies inv.

SetInventorySlotUi

MethodLink ↗
public void InventoryControlWrapper.SetInventorySlotUi(InventorySlotUiElement element, StashType stashType = StashType.NormalStash)

Calls SetInventorySlotUi on InventoryControlWrapper with element, stashType. This overload has no return value.

Return type: voidNo return value.

Parameters

element
Parameter type: InventorySlotUiElement

Specifies element.

stashType

Specifies stash type. Optional; the default is shown in the signature.

SetSingleSlotUi

MethodLink ↗
public void InventoryControlWrapper.SetSingleSlotUi(SingleSlotUiElement element)

Calls SetSingleSlotUi on InventoryControlWrapper with element. This overload has no return value.

Return type: voidNo return value.

Parameters

element
Parameter type: SingleSlotUiElement

Specifies element.

SplitStack

MethodLink ↗
public SplitStackResult InventoryControlWrapper.SplitStack(int value, bool actuallySplit = true)

Requests the specified quantity from an item stack in this grid. Check the returned result before continuing.

Return type: SplitStackResult
Explore SplitStackResult → members & methods

Named values for split stack result. Select a value when an API accepts or returns SplitStackResult.

Parameters

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

Specifies value.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The SplitStackResult result.

SplitStack

MethodLink ↗
public SplitStackResult InventoryControlWrapper.SplitStack(int localId, int value, bool actuallySplit = true)

Requests the specified quantity from an item stack in this grid. Check the returned result before continuing.

Return type: SplitStackResult
Explore SplitStackResult → members & methods

Named values for split stack result. Select a value when an API accepts or returns SplitStackResult.

Parameters

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

The item's identifier within its owning inventory; do not substitute a grid position.

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

Specifies value.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The SplitStackResult result.

UnequipSkillGem

MethodLink ↗
public UnequipSkillGemResult InventoryControlWrapper.UnequipSkillGem(int index, bool actuallyUnequip = true)

Unequips skill gem using the supplied arguments.

Return type: UnequipSkillGemResult
Explore UnequipSkillGemResult → members & methods

Named values for unequip skill gem result. Select a value when an API accepts or returns UnequipSkillGemResult.

Parameters

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

Specifies index.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The UnequipSkillGemResult result.

UnequipSkillGem

MethodLink ↗
public UnequipSkillGemResult InventoryControlWrapper.UnequipSkillGem(int localId, int index, bool actuallyUnequip = true)

Remove the gem in a host item's zero-based inner socket onto an empty cursor. In the G binding localId is the host main gem's ID; this does not remove the host. Scrolls and right-clicks once. actuallyUnequip=false validates without input for G. None means dispatch/validation succeeded; verify the cursor and socket afterwards.

Return type: UnequipSkillGemResult
Explore UnequipSkillGemResult → members & methods

Named values for unequip skill gem result. Select a value when an API accepts or returns UnequipSkillGemResult.

Parameters

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

The item's identifier within its owning inventory; do not substitute a grid position.

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

Specifies index.

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

Action-control flag. Support varies by overload; do not assume that false makes the operation side-effect-free.

Returns: The UnequipSkillGemResult result.

UseItem

MethodLink ↗
public UseItemResult InventoryControlWrapper.UseItem(bool actuallyUse = true)

Uses item using the supplied arguments.

Return type: UseItemResult
Explore UseItemResult → members & methods

Named values for use item result. Select a value when an API accepts or returns UseItemResult.

Parameters

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

Not read by this overload in the reviewed source. Do not rely on this argument to change its behavior.

Returns: The UseItemResult result.

UseItem

MethodLink ↗
public UseItemResult InventoryControlWrapper.UseItem(int localId, bool actuallyUse = true)

Uses item using the supplied arguments.

Return type: UseItemResult
Explore UseItemResult → members & methods

Named values for use item result. Select a value when an API accepts or returns UseItemResult.

Parameters

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

The item's identifier within its owning inventory; do not substitute a grid position.

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

Not read by this overload in the reviewed source. Do not rely on this argument to change its behavior.

Returns: The UseItemResult result.

ViewItemsInInventory

MethodLink ↗
public ViewItemsInInventoryResult InventoryControlWrapper.ViewItemsInInventory(ShouldViewItemDelegate shouldViewItem, Func<bool> isOpened)

Move the mouse over items to build the tooltip and make informations about prices available.

Return type: ViewItemsInInventoryResult
Explore ViewItemsInInventoryResult → members & methods

Named values for view items in inventory result. Select a value when an API accepts or returns ViewItemsInInventoryResult.

Parameters

shouldViewItem
Parameter type: ShouldViewItemDelegate

Specifies should view item.

isOpened
Parameter type: Func<bool>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies is opened.

Returns: The ViewItemsInInventoryResult result.

ViewItemsInInventory

MethodLink ↗
public ViewItemsInInventoryResult InventoryControlWrapper.ViewItemsInInventory(ShouldViewItemDelegate shouldViewItem, Func<bool> isOpened, bool dontClearKeysState)

Calls ViewItemsInInventory on InventoryControlWrapper with shouldViewItem, isOpened, dontClearKeysState and returns ViewItemsInInventoryResult. Open the return contract below before using the result.

Return type: ViewItemsInInventoryResult
Explore ViewItemsInInventoryResult → members & methods

Named values for view items in inventory result. Select a value when an API accepts or returns ViewItemsInInventoryResult.

Parameters

shouldViewItem
Parameter type: ShouldViewItemDelegate

Specifies should view item.

isOpened
Parameter type: Func<bool>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies is opened.

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

Specifies dont clear keys state.

Returns: The ViewItemsInInventoryResult result.

CustomTabItem

PropertyLink ↗
public Item InventoryControlWrapper.CustomTabItem { get; }

Reads custom tab item on InventoryControlWrapper as Item. Open the value type below for its members and accepted values.

Value 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.

CustomTabItemName

PropertyLink ↗
public string InventoryControlWrapper.CustomTabItemName { get; }

Reads custom tab item name on InventoryControlWrapper as string. The exact type and accessors are shown below.

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

CustomTabMetadata

PropertyLink ↗
public string InventoryControlWrapper.CustomTabMetadata { get; }

Reads custom tab metadata on InventoryControlWrapper as string. The exact type and accessors are shown below.

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

HasCustomTabOverride

PropertyLink ↗
public bool InventoryControlWrapper.HasCustomTabOverride { get; }

Whether custom tab override is present.

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

Guides using this class

See how these APIs fit together. Labs include complete source; the FollowBot walkthrough teaches you to build your own bot from selected fragments and checkpoints.

DPB2 0.4.5.103 · 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.