BankBuilder
A handler builder for banking actions.
ClassRLPlugins API
public class BankBuilder extends AbstractHandlerBuilder<BankBuilder>Constants
END_EXECUTION
Members
Constructors
- newBankBuilder()
Creates a BankBuilder.
Methods
- BankBuilderdeposit(BankBuilder.BankItem...)
Deposits the specified items into the bank.
- BankBuilderdepositEquipment()
Deposits all equipped items into the bank.
- BankBuilderdepositInventory()
Deposits the entire inventory into the bank.
- BankBuilderget()
Creates a new instance of the BankBuilder.
- BankBuilderopen()
Walks to and opens the nearest bank.
- BankBuilderopen(BankLocations)
Walks to and opens the specified bank location.
- BankBuilderuse(int)
Uses an item from the banks inventory interface.
- BankBuilderuseGuessNextSlot(int)
Uses an item from the banks inventory interface, guessing the next slot.
- BankBuilderwithdraw(boolean, BankBuilder.BankItem...)
Withdraws the specified items from the bank.
Inherited from AbstractHandlerBuilder
- BankBuilderadd(Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- BankBuilderadd(Function<StepContext, Integer>)
Adds a step to the handler.
- BankBuilderadd(Runnable)
Adds a step to the handler and assumes to return the next step number.
- BankBuilderadd(Supplier<Integer>)
Adds a step to the handler.
- BankBuilderadd(String, Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- BankBuilderadd(String, Function<StepContext, Integer>)
Adds a step to the handler.
- BankBuilderadd(String, Runnable)
Adds a step to the handler and assumes to return the next step number.
- BankBuilderadd(String, Supplier<Integer>)
Adds a step to the handler.
- BankBuilderaddDelay(int)
Adds a delay to the handler.
- BankBuilderaddDelay(String, int)
Adds a delay to the handler.
- BankBuilderaddDelayUntil(BooleanSupplier)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(Predicate<StepContext>)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(String, BooleanSupplier)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(String, Predicate<StepContext>)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(String, int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- BankBuilderaddDelayUntil(String, int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- BankBuilderappend(HandlerBuilder)
Appends a handler builder to the handler.
- BankBuilderappend(StepHandler)
Appends a step handler to the handler.
- BankBuilderappend(String, HandlerBuilder)
Appends a handler builder to the handler.
- BankBuilderappend(String, StepHandler)
Appends a step handler to the handler.
- BankBuilderwalkTo(WorldArea)
Adds a walk to step to the handler.
- BankBuilderwalkTo(WorldPoint)
Adds a walk to step to the handler.
- BankBuilderwalkTo(String, WorldArea)
Adds a walk to step to the handler.
- BankBuilderwalkTo(String, WorldPoint)
Adds a walk to step to the handler.
- BankBuilderwalkToWorldAreaSupplier(Supplier<WorldArea>)
Adds a walk to step to the handler.
- BankBuilderwalkToWorldAreaSupplier(String, Supplier<WorldArea>)
Adds a walk to step to the handler.
- BankBuilderwalkToWorldPointSupplier(Supplier<WorldPoint>)
Adds a walk to step to the handler.
- BankBuilderwalkToWorldPointSupplier(String, Supplier<WorldPoint>)
Adds a walk to step to the handler.
Inherited from HandlerBuilder
- HandlerBuilderadd(int, Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- HandlerBuilderadd(int, Function<StepContext, Integer>)
Adds a step to the handler.
- HandlerBuilderadd(int, Runnable)
Adds a step to the handler and assumes to return the next step number.
- HandlerBuilderadd(int, Supplier<Integer>)
Adds a step to the handler.
- HandlerBuilderaddDelay(int, int)
Adds a delay to the handler.
- HandlerBuilderaddDelayUntil(int, BooleanSupplier)
Adds a delay until a condition is met.
- HandlerBuilderaddDelayUntil(int, Predicate<StepContext>)
Adds a delay until a condition is met.
- HandlerBuilderaddDelayUntil(int, int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- HandlerBuilderaddDelayUntil(int, int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- HandlerBuilderappend(int, HandlerBuilder)
Append.
- HandlerBuilderappend(int, StepHandler)
Append.
- StepHandlerblank()
Blank.
- StepHandlerbuild()
Builds the TransportHandler.
- HandlerBuilderget()
Creates a new HandlerBuilder.
- int
- voidspeedUp(StepContext)
Speed up.
- HandlerBuilderwalkTo(int, WorldArea)
Walk to.
- HandlerBuilderwalkTo(int, WorldPoint)
Walk to.
- HandlerBuilderwalkToWorldAreaSupplier(int, Supplier<WorldArea>)
Walk to world area supplier.
- HandlerBuilderwalkToWorldPointSupplier(int, Supplier<WorldPoint>)
Walk to world point supplier.
BankBuilder()
public BankBuilder()Creates a BankBuilder.
deposit(BankBuilder.BankItem...)
public BankBuilder deposit(BankBuilder.BankItem... items)Deposits the specified items into the bank.
Parameters
items- The items to deposit.
Returns
BankBuilder instance.
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
depositEquipment()
public BankBuilder depositEquipment()Deposits all equipped items into the bank.
Returns
BankBuilder instance.
depositInventory()
public BankBuilder depositInventory()Deposits the entire inventory into the bank.
Returns
BankBuilder instance.
get()static
public static BankBuilder get()Creates a new instance of the BankBuilder.
Returns
A new BankBuilder instance.
open()
public BankBuilder open()Walks to and opens the nearest bank.
Returns
The current BankBuilder instance for chaining.
open(BankLocations)
public BankBuilder open(BankLocations bankLocation)Walks to and opens the specified bank location.
Parameters
bankLocation- The bank location to open.
Returns
BankBuilder instance.
use(int)
public BankBuilder use(int itemId)Uses an item from the banks inventory interface.
Parameters
itemId- The ID of the item to use.
Returns
BankBuilder instance.
useGuessNextSlot(int)
public BankBuilder useGuessNextSlot(int itemId)Uses an item from the banks inventory interface, guessing the next slot.
Parameters
itemId- The ID of the item to use.
Returns
BankBuilder instance.
withdraw(boolean, BankBuilder.BankItem...)
public BankBuilder withdraw(boolean noted, BankBuilder.BankItem... items)Withdraws the specified items from the bank.
Parameters
noted- Whether to withdraw the items as notes.
items- The items to withdraw.
Returns
BankBuilder instance.
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
add(Consumer<StepContext>)from AbstractHandlerBuilder
public BankBuilder add(Consumer<StepContext> consumer)Adds a step to the handler and assumes to return the next step number.
Parameters
consumer- The runnable to run.
Returns
The HandlerBuilder.
add(Function<StepContext, Integer>)from AbstractHandlerBuilder
public BankBuilder add(Function<StepContext, Integer> function)Adds a step to the handler.
Parameters
function- The function that returns the next step number.
Returns
The HandlerBuilder.
add(Runnable)from AbstractHandlerBuilder
public BankBuilder add(Runnable runnable)Adds a step to the handler and assumes to return the next step number.
Parameters
runnable- The runnable to run.
Returns
The HandlerBuilder.
add(Supplier<Integer>)from AbstractHandlerBuilder
public BankBuilder add(Supplier<Integer> supplier)Adds a step to the handler.
Parameters
supplier- The supplier that returns the next step number.
Returns
The HandlerBuilder.
add(String, Consumer<StepContext>)from AbstractHandlerBuilder
public BankBuilder add(String label, Consumer<StepContext> consumer)Adds a step to the handler and assumes to return the next step number.
Parameters
label- The label for the step.
consumer- The runnable to run.
Returns
The HandlerBuilder.
add(String, Function<StepContext, Integer>)from AbstractHandlerBuilder
public BankBuilder add(String label, Function<StepContext, Integer> function)Adds a step to the handler.
Parameters
label- The label for the step.
function- The function that returns the next step number.
Returns
The HandlerBuilder.
add(String, Runnable)from AbstractHandlerBuilder
public BankBuilder add(String label, Runnable runnable)Adds a step to the handler and assumes to return the next step number.
Parameters
label- The label for the step.
runnable- The runnable to run.
Returns
The HandlerBuilder.
add(String, Supplier<Integer>)from AbstractHandlerBuilder
public BankBuilder add(String label, Supplier<Integer> supplier)Adds a step to the handler.
Parameters
label- The label for the step.
supplier- The supplier that returns the next step number.
Returns
The HandlerBuilder.
addDelay(int)from AbstractHandlerBuilder
public BankBuilder addDelay(int delay)Adds a delay to the handler.
Parameters
delay- The delay in steps.
Returns
The HandlerBuilder.
addDelay(String, int)from AbstractHandlerBuilder
public BankBuilder addDelay(String label, int delay)Adds a delay to the handler.
Parameters
label- The label for the step.
delay- The delay in steps.
Returns
The HandlerBuilder.
addDelayUntil(BooleanSupplier)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(BooleanSupplier condition)Adds a delay until a condition is met.
Parameters
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(Predicate<StepContext>)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(Predicate<StepContext> condition)Adds a delay until a condition is met.
Parameters
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(String, BooleanSupplier)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(String label, BooleanSupplier condition)Adds a delay until a condition is met.
Parameters
label- The label for the step.
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(String, Predicate<StepContext>)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(String label, Predicate<StepContext> condition)Adds a delay until a condition is met.
Parameters
label- The label for the step.
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(int, BooleanSupplier, Runnable)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(int timeout, BooleanSupplier condition, Runnable onTimeout)Adds a delay until a condition is met.
Parameters
timeout- The timeout in steps.
condition- The condition to meet.
onTimeout- The action to perform on timeout.
Returns
The HandlerBuilder.
addDelayUntil(int, Predicate<StepContext>, Consumer<StepContext>)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(int timeout, Predicate<StepContext> condition, Consumer<StepContext> onTimeout)Adds a delay until a condition is met.
Parameters
timeout- The timeout in steps.
condition- The condition to meet.
onTimeout- The action to perform on timeout.
Returns
The HandlerBuilder.
addDelayUntil(String, int, BooleanSupplier, Runnable)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(String label, int timeout, BooleanSupplier condition, Runnable onTimeout)Adds a delay until a condition is met.
Parameters
label- The label for the step.
timeout- The timeout in steps.
condition- The condition to meet.
onTimeout- The action to perform on timeout.
Returns
The HandlerBuilder.
addDelayUntil(String, int, Predicate<StepContext>, Consumer<StepContext>)from AbstractHandlerBuilder
public BankBuilder addDelayUntil(String label, int timeout, Predicate<StepContext> condition, Consumer<StepContext> onTimeout)Adds a delay until a condition is met.
Parameters
label- The label for the step.
timeout- The timeout in steps.
condition- The condition to meet.
onTimeout- The action to perform on timeout.
Returns
The HandlerBuilder.
append(HandlerBuilder)from AbstractHandlerBuilder
public BankBuilder append(HandlerBuilder builder)Appends a handler builder to the handler.
Parameters
builder- The handler builder to append.
Returns
The HandlerBuilder.
append(StepHandler)from AbstractHandlerBuilder
public BankBuilder append(StepHandler handler)Appends a step handler to the handler.
Parameters
handler- The step handler to append.
Returns
The HandlerBuilder.
append(String, HandlerBuilder)from AbstractHandlerBuilder
public BankBuilder append(String label, HandlerBuilder builder)Appends a handler builder to the handler.
Parameters
label- The label for the step.
builder- The handler builder to append.
Returns
The HandlerBuilder.
append(String, StepHandler)from AbstractHandlerBuilder
public BankBuilder append(String label, StepHandler handler)Appends a step handler to the handler.
Parameters
label- The label for the step.
handler- The step handler to append.
Returns
The HandlerBuilder.
walkTo(WorldArea)from AbstractHandlerBuilder
public BankBuilder walkTo(WorldArea location)Adds a walk to step to the handler.
Parameters
location- The location to walk to.
Returns
The HandlerBuilder.
walkTo(WorldPoint)from AbstractHandlerBuilder
public BankBuilder walkTo(WorldPoint location)Adds a walk to step to the handler.
Parameters
location- The location to walk to.
Returns
The HandlerBuilder.
walkTo(String, WorldArea)from AbstractHandlerBuilder
public BankBuilder walkTo(String label, WorldArea location)Adds a walk to step to the handler.
Parameters
label- The label for the step.
location- The location to walk to.
Returns
The HandlerBuilder.
walkTo(String, WorldPoint)from AbstractHandlerBuilder
public BankBuilder walkTo(String label, WorldPoint location)Adds a walk to step to the handler.
Parameters
label- The label for the step.
location- The location to walk to.
Returns
The HandlerBuilder.
walkToWorldAreaSupplier(Supplier<WorldArea>)from AbstractHandlerBuilder
public BankBuilder walkToWorldAreaSupplier(Supplier<WorldArea> location)Adds a walk to step to the handler.
Parameters
location- The location to walk to.
Returns
The HandlerBuilder.
walkToWorldAreaSupplier(String, Supplier<WorldArea>)from AbstractHandlerBuilder
public BankBuilder walkToWorldAreaSupplier(String label, Supplier<WorldArea> location)Adds a walk to step to the handler.
Parameters
label- The label for the step.
location- The location to walk to.
Returns
The HandlerBuilder.
walkToWorldPointSupplier(Supplier<WorldPoint>)from AbstractHandlerBuilder
public BankBuilder walkToWorldPointSupplier(Supplier<WorldPoint> location)Adds a walk to step to the handler.
Parameters
location- The location to walk to.
Returns
The HandlerBuilder.
walkToWorldPointSupplier(String, Supplier<WorldPoint>)from AbstractHandlerBuilder
public BankBuilder walkToWorldPointSupplier(String label, Supplier<WorldPoint> location)Adds a walk to step to the handler.
Parameters
label- The label for the step.
location- The location to walk to.
Returns
The HandlerBuilder.
add(int, Consumer<StepContext>)from HandlerBuilder
public HandlerBuilder add(int step, Consumer<StepContext> consumer)Adds a step to the handler and assumes to return the next step number.
Parameters
step- The step number.
consumer- The runnable to run.
Returns
The HandlerBuilder.
add(int, Function<StepContext, Integer>)from HandlerBuilder
public HandlerBuilder add(int step, Function<StepContext, Integer> function)Adds a step to the handler.
Parameters
step- The step number.
function- The function that returns the next step number.
Returns
The HandlerBuilder.
add(int, Runnable)from HandlerBuilder
public HandlerBuilder add(int step, Runnable runnable)Adds a step to the handler and assumes to return the next step number.
Parameters
step- The step number.
runnable- The runnable to run.
Returns
The HandlerBuilder.
add(int, Supplier<Integer>)from HandlerBuilder
public HandlerBuilder add(int step, Supplier<Integer> supplier)Adds a step to the handler.
Parameters
step- The step number.
supplier- The supplier that returns the next step number.
Returns
The HandlerBuilder.
addDelay(int, int)from HandlerBuilder
public HandlerBuilder addDelay(int step, int delay)Adds a delay to the handler.
Parameters
step- The step number.
delay- The delay in steps.
Returns
The HandlerBuilder.
addDelayUntil(int, BooleanSupplier)from HandlerBuilder
public HandlerBuilder addDelayUntil(int step, BooleanSupplier condition)Adds a delay until a condition is met.
Parameters
step- The step number.
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(int, Predicate<StepContext>)from HandlerBuilder
public HandlerBuilder addDelayUntil(int step, Predicate<StepContext> condition)Adds a delay until a condition is met.
Parameters
step- The step number.
condition- The condition to meet.
Returns
The HandlerBuilder.
addDelayUntil(int, int, BooleanSupplier, Runnable)from HandlerBuilder
public HandlerBuilder addDelayUntil(int step, int timeout, BooleanSupplier condition, Runnable onTimeout)Adds a delay until a condition is met.
Parameters
step- The step number.
timeout- Timeout.
condition- The condition to meet.
onTimeout- On timeout.
Returns
The HandlerBuilder.
addDelayUntil(int, int, Predicate<StepContext>, Consumer<StepContext>)from HandlerBuilder
public HandlerBuilder addDelayUntil(int step, int timeout, Predicate<StepContext> condition, Consumer<StepContext> onTimeout)Adds a delay until a condition is met.
Parameters
step- The step number.
timeout- Timeout.
condition- The condition to meet.
onTimeout- On timeout.
Returns
The HandlerBuilder.
append(int, HandlerBuilder)from HandlerBuilder
public HandlerBuilder append(int step, HandlerBuilder builder)Append.
Parameters
step- Step.
builder- Builder.
append(int, StepHandler)from HandlerBuilder
public HandlerBuilder append(int step, StepHandler handler)Append.
Parameters
step- Step.
handler- Handler.
blank()staticfrom HandlerBuilder
public static StepHandler blank()Blank.
build()from HandlerBuilder
public StepHandler build()Builds the TransportHandler.
Returns
The TransportHandler.
get()staticfrom HandlerBuilder
public static HandlerBuilder get()Creates a new HandlerBuilder.
Returns
The HandlerBuilder.
jump(String, StepContext)staticfrom HandlerBuilder
public static int jump(String label, StepContext context)Jump.
Parameters
label- Label.
context- Context.
speedUp(StepContext)staticfrom HandlerBuilder
public static void speedUp(StepContext context)Speed up.
Parameters
context- Context.
walkTo(int, WorldArea)from HandlerBuilder
public HandlerBuilder walkTo(int step, WorldArea location)Walk to.
Parameters
step- Step.
location- Location.
walkTo(int, WorldPoint)from HandlerBuilder
public HandlerBuilder walkTo(int step, WorldPoint location)Walk to.
Parameters
step- Step.
location- Location.
walkToWorldAreaSupplier(int, Supplier<WorldArea>)from HandlerBuilder
public HandlerBuilder walkToWorldAreaSupplier(int step, Supplier<WorldArea> locationSupplier)Walk to world area supplier.
Parameters
step- Step.
locationSupplier- Location supplier.
walkToWorldPointSupplier(int, Supplier<WorldPoint>)from HandlerBuilder
public HandlerBuilder walkToWorldPointSupplier(int step, Supplier<WorldPoint> locationSupplier)Walk to world point supplier.
Parameters
step- Step.
locationSupplier- Location supplier.
Also allowed
Every class has these, as in plain Java.
equals, toString