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

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.

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 localId, 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

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.

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

In the G-panel binding, public DPB2 0.4.5.91 recognizes valid gems missing from the static item catalogue. Socket indexes are zero-based; the game still decides compatibility. Use the panel's InventoryControl, reacquire after navigation and inspect the outcome before continuing.

EquipSkillGem

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

Place the physical cursor gem into a host item's zero-based inner socket. In the G binding localId is the host main gem's ID, not a main-slot number. Supports and other gems accepted by the host (such as meta-skill payloads) use this path. actuallyEquip=false validates without input for G; the game decides compatibility. None means dispatch/validation succeeded, not confirmed socketing.

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

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.

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.

In the G-panel binding, public DPB2 0.4.5.91 recognizes valid gems missing from the static item catalogue. Socket indexes are zero-based; the game still decides compatibility. Use the panel's InventoryControl, reacquire after navigation and inspect the outcome before continuing.

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.

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.

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.

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.

FastMove

MethodLink ↗
public FastMoveResult InventoryControlWrapper.FastMove(int localId, 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

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.

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.

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.

FastMove

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

Ctrl-click the item with this local inventory ID. For SkillGemPanelUi.InventoryControl, removes a main gem towards the main inventory; requires I and G open, hooks enabled and an empty cursor. Scrolls first and restores Ctrl even if dispatch fails. actuallyMove=false performs validation only for this panel binding. None does not guarantee transfer: the game may reject it (for example, a full inventory).

Return type: FastMoveResult
Explore FastMoveResult → members & methods

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

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.

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.

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.

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 localId, 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

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.

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 localId, 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

localId
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 localId)

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

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.

Returns: The int result.

GetIntRequirement

MethodLink ↗
public int InventoryControlWrapper.GetIntRequirement(int localId)

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

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.

Returns: The int result.

GetItemCost

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

Used to retrieve price for item in trade inventory, for example the merchant Ui or buy/sell Ui. This also include the gold price, tagged as Gold. PLEASE NOTE! the price is built over the tooltip, and the Tooltip is not built till you over over an item at least once, so to make this function work, you need to use the function 'ViewItemsInInventory' that does exactly that, move the mouse over an item and allow the game to build the tooltip.

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

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

Item LocalId

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

out, list of price of the item, the gold price is tagged "Gold".

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

Receives can afford.

Returns: GetItemCostResult.None or the relative error.

GetItemDeferalCostEx

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

Calls GetItemDeferalCostEx on InventoryControlWrapper with localId, 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

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.

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.

GetItemGoldCost

MethodLink ↗
public GetItemCostResult InventoryControlWrapper.GetItemGoldCost(int localId, out int goldCost, out bool canAfford)

Used to retrieve gold price, and a boolean describing if a item can be bought. PLEASE NOTE! the price is built over the tooltip, and the Tooltip is not built till you over over an item at least once, so to make this function work, you need to use the function 'ViewItemsInInventory' that does exactly that, move the mouse over an item and allow the game to build the tooltip.

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

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

Item LocalId

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

out, gold cost of the item.

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

out, true if you have the golds to buy this item.

Returns: GetItemCostResult.None or the relative error.

GetItemGoldSellPrice

MethodLink ↗
public GetItemGoldSellPriceResult InventoryControlWrapper.GetItemGoldSellPrice(int localId, out int goldSellPrice)

Used to retrieve sell price for item in inventory. PLEASE NOTE! the price is built over the tooltip, and the Tooltip is not built till you over over an item at least once, so to make this function work, you need to use the function 'ViewItemsInInventory' that does exactly that, move the mouse over an item and allow the game to build the tooltip.

Return type: GetItemGoldSellPriceResult
Explore GetItemGoldSellPriceResult → members & methods

Named values for get item gold sell price result. Select a value when an API accepts or returns GetItemGoldSellPriceResult.

Parameters

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

Item LocalId

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

out, sell price of the item.

Returns: GetItemGoldSellPriceResult.None or the relative error.

GetItemTributeCostEx

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

Calls GetItemTributeCostEx on InventoryControlWrapper with localId, 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

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.

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.

GetLevelRequirement

MethodLink ↗
public int InventoryControlWrapper.GetLevelRequirement(int localId)

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

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.

Returns: The int result.

GetStrRequirement

MethodLink ↗
public int InventoryControlWrapper.GetStrRequirement(int localId)

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

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.

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 localId)

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

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.

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.

MergeStack

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

Calls MergeStack on InventoryControlWrapper with localId, 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

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.

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.

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.