Package dev.twilite.game.loadout

Class Restocker

java.lang.Object
dev.twilite.game.loadout.Restocker
All Implemented Interfaces:
ItemDepletionListener
public class Restocker extends Object implements ItemDepletionListener
Grand Exchange restocking helper that can be used as a loadout depletion listener.

Register preferred restock quantities with item(int, int), attach the restocker to an InventoryLoadout using InventoryLoadout.depletionListener(ItemDepletionListener), and call tick() while the script is in its restocking branch. Each call performs at most one meaningful Grand Exchange step so client state can update between calls.

  • Constructor Details

    • Restocker

      public Restocker()

  • Method Details

    • create

      public static Restocker create()
      Creates an empty restocker.

    • defaultAmount

      public Restocker defaultAmount(int amount)
      Sets the fallback amount for depleted items that do not have an explicit restock entry.

    • defaultRetryAfterTicks

      public Restocker defaultRetryAfterTicks(int ticks)
      Sets how long an active offer may sit before it is aborted and retried.

    • defaultMaxRetries

      public Restocker defaultMaxRetries(int retries)
      Sets how many times a stale active offer may be aborted and repriced.

    • defaultBuyPrice

      public Restocker defaultBuyPrice(GrandExchange.Price price)
      Sets the default price resolver for newly registered restock entries.

    • defaultSellPrice

      public Restocker defaultSellPrice(GrandExchange.Price sellPrice)
      Sets the default price resolver for sell requests.

    • defaultCollectionMode

      public Restocker defaultCollectionMode(GrandExchange.CollectionMode collectionMode)
      Sets where completed restock offers should be collected.

    • allowWithdrawTeleports

      public Restocker allowWithdrawTeleports()
      Allows the restocker to withdraw a Grand Exchange teleport from a nearby bank before walking there.

    • allowWithdrawTeleports

      public Restocker allowWithdrawTeleports(boolean allowWithdrawTeleports)
      Sets whether the restocker may withdraw a Grand Exchange teleport from a nearby bank before walking there.

    • item

      public Restocker.Request item(int itemId, int amount)
      Registers a restock entry using the restocker's default price resolver.

    • item

      public Restocker.Request item(int itemId, int amount, GrandExchange.Price price)
      Registers a restock entry.

    • sell

      public Restocker.Request sell(int itemId, int amount)
      Queues a sell request using the restocker's default sell price resolver.

    • sell

      public Restocker.Request sell(int itemId, int amount, GrandExchange.Price price)
      Queues a sell request.

    • request

      public Restocker request(int itemId)
      Queues a restock request for an item id.

    • request

      public Restocker request(int itemId, int amount)
      Queues a restock request for an item id and amount.

    • requestSell

      public Restocker requestSell(int itemId)
      Queues a configured sell request.

    • requestSell

      public Restocker requestSell(int itemId, int amount)
      Queues a sell request for an item id and amount.

    • request

      public Restocker request(LoadoutItem item)
      Queues the configured restock entry for a depleted loadout item.

    • onDeplete

      public void onDeplete(LoadoutItem item)
      Called by loadouts when a required item is missing from the bank.
      Specified by:
      onDeplete in interface ItemDepletionListener

    • queued

      public List<Restocker.Request> queued()
      Returns queued restock entries.

    • items

      public Collection<Restocker.Request> items()
      Returns all configured restock entries.

    • empty

      public boolean empty()
      Returns whether no restock entries are currently queued.

    • clear

      public void clear()
      Clears all queued requests but keeps configured restock quantities.

    • tick

      public void tick()
      Progresses collection, buying, and selling for queued restock entries.