DPB1Class · 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: 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

76 declared here

InventorySlotUiElement

FieldLink ↗
public InventorySlotUiElement InventoryControlWrapper.InventorySlotUiElement

Reads or assigns inventory slot ui element on InventoryControlWrapper as InventorySlotUiElement. Open the value type below for its members and accepted values.

Value type: InventorySlotUiElement
Explore InventorySlotUiElement → members & methods

Reads inventory slot ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.

SingleSlotUiElement

FieldLink ↗
public SingleSlotUiElement InventoryControlWrapper.SingleSlotUiElement

Reads or assigns single slot ui element on InventoryControlWrapper as SingleSlotUiElement. Open the value type below for its members and accepted values.

Value type: SingleSlotUiElement
Explore SingleSlotUiElement → members & methods

Reads single slot ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.

InventoryControlWrapper

MethodLink ↗
public InventoryControlWrapper.InventoryControlWrapper()

Creates a new InventoryControlWrapper instance.

InventoryControlWrapper

MethodLink ↗
public InventoryControlWrapper.InventoryControlWrapper(bool Emptycurrency)

Creates a new InventoryControlWrapper instance using the supplied arguments.

Parameters

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

Specifies emptycurrency.

ApplyCursorAt

MethodLink ↗
public ApplyCursorResult InventoryControlWrapper.ApplyCursorAt(int col, int row, bool actuallyApply = true)

Applies the current cursor action to the item at the specified grid column and row. Check the returned result before continuing.

Return type: ApplyCursorResult
Explore ApplyCursorResult → members & methods

Named values for apply cursor result. Select a value when an API accepts or returns ApplyCursorResult.

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.

actuallyApply
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 ApplyCursorResult result.

ApplyCursorTo

MethodLink ↗
public ApplyCursorResult InventoryControlWrapper.ApplyCursorTo(bool actuallyApply = true)

Applies the current cursor action to the item selected by this overload. Check the returned result before continuing.

Return type: ApplyCursorResult
Explore ApplyCursorResult → members & methods

Named values for apply cursor result. Select a value when an API accepts or returns ApplyCursorResult.

Parameters

actuallyApply
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 ApplyCursorResult result.

ApplyCursorTo

MethodLink ↗
public ApplyCursorResult InventoryControlWrapper.ApplyCursorTo(int id, bool actuallyApply = true)

Applies the current cursor action to the item selected by this overload. Check the returned result before continuing.

Return type: ApplyCursorResult
Explore ApplyCursorResult → members & methods

Named values for apply cursor result. Select a value when an API accepts or returns ApplyCursorResult.

Parameters

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

Specifies id.

actuallyApply
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 ApplyCursorResult result.

BeginApplyCursor

MethodLink ↗
public static ApplyCursorResult InventoryControlWrapper.BeginApplyCursor(bool holdShift = false)

Begins applying the cursor action, optionally keeping Shift held for repeated use. Check the returned result before continuing.

Return type: ApplyCursorResult
Explore ApplyCursorResult → members & methods

Named values for apply cursor result. Select a value when an API accepts or returns ApplyCursorResult.

Parameters

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

Specifies hold shift. Optional; the default is shown in the signature.

Returns: The ApplyCursorResult result.

EndApplyCursor

MethodLink ↗
public static ApplyCursorResult InventoryControlWrapper.EndApplyCursor()

Ends the active cursor-application sequence and releases its input state. Check the returned result before continuing.

Return type: ApplyCursorResult
Explore ApplyCursorResult → members & methods

Named values for apply cursor result. Select a value when an API accepts or returns ApplyCursorResult.

Returns: The ApplyCursorResult result.

EquipSkillGem

MethodLink ↗
public EquipSkillGemResult InventoryControlWrapper.EquipSkillGem(int index, bool actuallyEquip = true)

Requests equipping the skill gem using the selected item and socket index. Check the returned result before continuing.

Return type: EquipSkillGemResult
Explore EquipSkillGemResult → members & methods

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

Parameters

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

Specifies index.

actuallyEquip
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 EquipSkillGemResult result.

EquipSkillGem

MethodLink ↗
public EquipSkillGemResult InventoryControlWrapper.EquipSkillGem(int id, int index, bool actuallyEquip = true)

Requests equipping the skill gem using the selected item and socket index. Check the returned result before continuing.

Return type: EquipSkillGemResult
Explore EquipSkillGemResult → members & methods

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

Parameters

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

Specifies id.

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

Specifies index.

actuallyEquip
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 EquipSkillGemResult result.

FastMove

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMove(bool actuallyMove = true, bool ignoreIncubators = true, bool IgnoreCursorState = false)

Requests a quick transfer of an item from this grid to the destination chosen by the open game interface. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

IgnoreCursorState
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 FastMoveResult result.

FastMove

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMove(bool dontClearKeysState, bool actuallyMove = true, bool ignoreIncubators = true, bool IgnoreCursorState = false)

Requests a quick transfer of an item from this grid to the destination chosen by the open game interface. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

Specifies dont clear keys state.

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

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

Specifies ignore cursor state. Optional; the default is shown in the signature.

Returns: The FastMoveResult result.

FastMove

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMove(int id, bool actuallyMove = true, bool ignoreIncubators = true)

Requests a quick transfer of an item from this grid to the destination chosen by the open game interface. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

Specifies id.

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

Returns: The FastMoveResult result.

FastMove

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMove(int id, bool dontClearKeysState, bool actuallyMove = true, bool ignoreIncubators = true)

Requests a quick transfer of an item from this grid to the destination chosen by the open game interface. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

Specifies id.

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

Specifies dont clear keys state.

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

Returns: The FastMoveResult result.

FastMoveAll

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMoveAll(bool dontClearKeysState = false, bool actuallyMove = true, bool ignoreIncubators = true, bool IgnoreCursorState = false)

Requests the interface's bulk quick-transfer action for the selected item. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

Specifies dont clear keys state. Optional; the default is shown in the signature.

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

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

Specifies ignore cursor state. Optional; the default is shown in the signature.

Returns: The FastMoveResult result.

FastMoveAll

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMoveAll(int id, bool dontClearKeysState = false, bool actuallyMove = true, bool ignoreIncubators = true)

Requests the interface's bulk quick-transfer action for the selected item. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

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

Specifies id.

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

Specifies dont clear keys state. Optional; the default is shown in the signature.

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

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

Specifies ignore incubators. Optional; the default is shown in the signature.

Returns: The FastMoveResult result.

FastMoveReward

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMoveReward(int id, bool actuallyMove = true)

Requests a quick transfer of the identified reward item. Check the returned result before continuing.

Return type: FastMoveResult
Explore FastMoveResult → members & methods

Named values for fast move result. Select a value when an API accepts or returns FastMoveResult.

Parameters

id
Parameter type: intNo 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.

actuallyMove
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 FastMoveResult result.

GetDexRequirement

MethodLink ↗
public int InventoryControlWrapper.GetDexRequirement(int id)

Calls GetDexRequirement on InventoryControlWrapper with id 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

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

Specifies id.

Returns: The int result.

GetIntRequirement

MethodLink ↗
public int InventoryControlWrapper.GetIntRequirement(int id)

Calls GetIntRequirement on InventoryControlWrapper with id 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

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

Specifies id.

Returns: The int result.

GetItemCostAsDouble

MethodLink ↗
public GetItemCostResult InventoryControlWrapper.GetItemCostAsDouble(int id, out List<KeyValuePair<string, double>> info, out bool canAfford)

Calls GetItemCostAsDouble on InventoryControlWrapper with id, info, canAfford and returns GetItemCostResult. Open the return contract below before using the result.

Return type: GetItemCostResult
Explore GetItemCostResult → members & methods

Named values for get item cost result. Select a value when an API accepts or returns GetItemCostResult.

Parameters

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

Specifies id.

info
Parameter type: List<KeyValuePair<string, double>>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives info.

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

Receives can afford.

Returns: The GetItemCostResult result.

GetItemCostEx

MethodLink ↗
public GetItemCostResult InventoryControlWrapper.GetItemCostEx(int id, out List<KeyValuePair<string, int>> info, out bool canAfford)

Calls GetItemCostEx on InventoryControlWrapper with id, info, canAfford and returns GetItemCostResult. Open the return contract below before using the result.

Return type: GetItemCostResult
Explore GetItemCostResult → members & methods

Named values for get item cost result. Select a value when an API accepts or returns GetItemCostResult.

Parameters

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

Specifies id.

info
Parameter type: List<KeyValuePair<string, int>>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives info.

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

Receives can afford.

Returns: The GetItemCostResult result.

GetItemDeferalCostEx

MethodLink ↗
public GetItemDeferalCostResult InventoryControlWrapper.GetItemDeferalCostEx(int id, out int futureDiscount, out int deferalFee, out int totalDeferalCost)

Calls GetItemDeferalCostEx on InventoryControlWrapper with id, futureDiscount, deferalFee, totalDeferalCost and returns GetItemDeferalCostResult. Open the return contract below before using the result.

Return type: GetItemDeferalCostResult
Explore GetItemDeferalCostResult → members & methods

Named values for get item deferal cost result. Select a value when an API accepts or returns GetItemDeferalCostResult.

Parameters

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

Specifies id.

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

Receives future discount.

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

Receives deferal fee.

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

Receives total deferal cost.

Returns: The GetItemDeferalCostResult result.

GetItemTributeCostEx

MethodLink ↗
public GetItemTributeCostResult InventoryControlWrapper.GetItemTributeCostEx(int id, out int tributeCost, out bool canAfford)

Calls GetItemTributeCostEx on InventoryControlWrapper with id, tributeCost, canAfford and returns GetItemTributeCostResult. Open the return contract below before using the result.

Return type: GetItemTributeCostResult
Explore GetItemTributeCostResult → members & methods

Named values for get item tribute cost result. Select a value when an API accepts or returns GetItemTributeCostResult.

Parameters

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

Specifies id.

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

Receives tribute cost.

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

Receives can afford.

Returns: The GetItemTributeCostResult result.

GetItemsHighlightedByRegex

MethodLink ↗
public List<Item> InventoryControlWrapper.GetItemsHighlightedByRegex()

Return a List of Items actually Highlighted by the search regex.

Return type: List<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.

Returns: List of Item.

GetLevelRequirement

MethodLink ↗
public int InventoryControlWrapper.GetLevelRequirement(int id)

Calls GetLevelRequirement on InventoryControlWrapper with id 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

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

Specifies id.

Returns: The int result.

GetStrRequirement

MethodLink ↗
public int InventoryControlWrapper.GetStrRequirement(int id)

Calls GetStrRequirement on InventoryControlWrapper with id 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

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

Specifies id.

Returns: The int result.

IsItemDeferred

MethodLink ↗
public bool InventoryControlWrapper.IsItemDeferred(int localId)

Returns true if item is deferred in DreamPoeBot.Loki.Game.LokiPoe.InGameState.RitualFavorsUi InventoryControl

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

Parameters

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

local id of the item in ritual rewards window.

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

IsItemTransparent

MethodLink ↗
public bool InventoryControlWrapper.IsItemTransparent(int id)

Checks whether item transparent using the supplied arguments.

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

Parameters

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

Specifies id.

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

MergeStack

MethodLink ↗
public MergeStackResult InventoryControlWrapper.MergeStack(bool actuallyMerge = true)

Calls MergeStack on InventoryControlWrapper with actuallyMerge and returns MergeStackResult. Open the return contract below before using the result.

Return type: MergeStackResult
Explore MergeStackResult → members & methods

Named values for merge stack result. Select a value when an API accepts or returns MergeStackResult.

Parameters

actuallyMerge
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 MergeStackResult result.

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.

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.