InventoryControlWrapper

public OpenDisplayNoteResult InventoryControlWrapper.OpenDisplayNote(bool actuallyUse = true)

Opens display note using the supplied arguments.

actuallyUsebool

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

Returns: The OpenDisplayNoteResult result.

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

Opens display note using the supplied arguments.

localIdint

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

actuallyUsebool

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

Returns: The OpenDisplayNoteResult result.

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.

actuallyPickupbool

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

Returns: The PickupResult result.

public PickupResult InventoryControlWrapper.Pickup(int localId, 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.

localIdint

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

actuallyPickupbool

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

Returns: The PickupResult result.

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

Places the item currently held by the cursor into this inventory grid. Check the returned result before continuing.

allowOverlapbool

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

actuallyPlacebool

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

Returns: The PlaceCursorIntoResult result.

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

Places the item currently held by the cursor into this inventory grid. Check the returned result before continuing.

colint

The target column in the inventory grid.

rowint

The target row in the inventory grid.

allowOverlapbool

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

actuallyPlacebool

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

Returns: The PlaceCursorIntoResult result.

public void InventoryControlWrapper.SetInventory(Inventory inv)

Sets inventory using the supplied arguments.

invInventory

Specifies inv.

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

Sets inventory slot ui using the supplied arguments.

elementInventorySlotUiElement

Specifies element.

stashTypeStashType

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

public void InventoryControlWrapper.SetSingleSlotUi(SingleSlotUiElement element)

Sets single slot ui using the supplied arguments.

elementSingleSlotUiElement

Specifies element.

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.

valueint

Specifies value.

actuallySplitbool

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

Returns: The SplitStackResult result.

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.

localIdint

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

valueint

Specifies value.

actuallySplitbool

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

Returns: The SplitStackResult result.

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

Unequips skill gem using the supplied arguments.

indexint

Specifies index.

actuallyUnequipbool

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

Returns: The UnequipSkillGemResult result.

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

Unequips skill gem using the supplied arguments.

localIdint

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

indexint

Specifies index.

actuallyUnequipbool

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

Returns: The UnequipSkillGemResult result.

public UseItemResult InventoryControlWrapper.UseItem(bool actuallyUse = true)

Uses item using the supplied arguments.

actuallyUsebool

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

Returns: The UseItemResult result.

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

Uses item using the supplied arguments.

localIdint

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

actuallyUsebool

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

Returns: The UseItemResult result.

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

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

shouldViewItemShouldViewItemDelegate

Specifies should view item.

isOpenedFunc<bool>

Specifies is opened.

Returns: The ViewItemsInInventoryResult result.

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

Executes the view items in inventory operation with the supplied arguments.

shouldViewItemShouldViewItemDelegate

Specifies should view item.

isOpenedFunc<bool>

Specifies is opened.

dontClearKeysStatebool

Specifies dont clear keys state.

Returns: The ViewItemsInInventoryResult result.

public Item InventoryControlWrapper.CustomTabItem { get; }

Gets custom tab item for InventoryControlWrapper.

public string InventoryControlWrapper.CustomTabItemName { get; }

Gets custom tab item name for InventoryControlWrapper.

public string InventoryControlWrapper.CustomTabMetadata { get; }

Gets custom tab metadata for InventoryControlWrapper.

public bool InventoryControlWrapper.HasCustomTabOverride { get; }

Whether custom tab override is present.

public Inventory InventoryControlWrapper.Inventory { get; }

Gets inventory for InventoryControlWrapper.