java.lang.Object
- net.openosrs.api.service.inventory.InventoryService

@Singleton
public class InventoryService
extends java.lang.Object

Inventory reads and menu-first slot interactions.

Constructor Summary

Constructors
Constructor	Description
`InventoryService(net.runelite.api.Client client, MenuDispatcher dispatcher)`
`InventoryService(net.runelite.api.Client client, MenuDispatcher dispatcher, InventoryLifetimes lifetimes)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<InventoryItem>`	`all()`
`int`	`count(int id)`
`void`	`drop(InventoryItem item)`
`InventoryItem`	`first(int id)`
`InventoryItem`	`first(java.lang.String name)`
`void`	`interact(InventoryItem item, java.lang.String action)`
`boolean`	`isEmpty()`
`boolean`	`isFull()`
`void`	`requireCurrent(InventoryItem item)`
`void`	`requireHeld(InventoryItem item)`	Checks that the item is still in its slot, without requiring the inventory to be on screen.
`InventoryQuery`	`search()`
`void`	`use(InventoryItem item)`
`SubmissionResult`	`useAsync(InventoryItem item)`	Native selection completion; never wait on the client thread.
`void`	`useOn(InventoryItem item, GroundItemRef groundItem)`
`void`	`useOn(InventoryItem item, InventoryItem target)`
`void`	`useOn(InventoryItem item, NpcRef npc)`
`void`	`useOn(InventoryItem item, ObjectRef object)`
`void`	`useOn(InventoryItem item, PlayerRef player)`
`SubmissionResult`	`useOnAsync(InventoryItem item, GroundItemRef groundItem)`	Selects the item, waits for native acknowledgement, then revalidates and clicks the target.
`SubmissionResult`	`useOnAsync(InventoryItem item, InventoryItem target)`	Selects the item, waits for native acknowledgement, then revalidates and clicks the target.
`SubmissionResult`	`useOnAsync(InventoryItem item, NpcRef npc)`	Selects the item, waits for native acknowledgement, then revalidates and clicks the target.
`SubmissionResult`	`useOnAsync(InventoryItem item, ObjectRef object)`	Selects the item, waits for native acknowledgement, then revalidates and clicks the target.
`SubmissionResult`	`useOnAsync(InventoryItem item, PlayerRef player)`	Selects the item, waits for native acknowledgement, then revalidates and clicks the target.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InventoryService

public InventoryService(net.runelite.api.Client client,
                        MenuDispatcher dispatcher)

InventoryService

@Inject
public InventoryService(net.runelite.api.Client client,
                        MenuDispatcher dispatcher,
                        InventoryLifetimes lifetimes)

Method Detail

all

public java.util.List<InventoryItem> all()

search
```
public InventoryQuery search()
```

first

public InventoryItem first(int id)

first

public InventoryItem first(java.lang.String name)

count
```
public int count(int id)
```

isEmpty
```
public boolean isEmpty()
```

isFull
```
public boolean isFull()
```

use

public void use(InventoryItem item)

useAsync
```
public SubmissionResult useAsync(InventoryItem item)
```
Native selection completion; never wait on the client thread.