NpcBuilder
A builder for creating NPC interaction handlers.
ClassRLPlugins API
public class NpcBuilder extends AbstractHandlerBuilder<NpcBuilder>Constants
END_EXECUTION
Members
Constructors
- newNpcBuilder()
Creates a NpcBuilder.
Methods
- NpcBuilderattack(NpcLocations)
Walks to and Attacks an NPC at a specified location.
- NpcBuilderget()
Creates a new instance of NpcBuilder.
- NpcBuilderinteract(String, String)
Adds an interaction with an NPC to the handler.
- NpcBuildertalkTo(NpcLocations)
Walks to and Talks to an NPC at a specified location.
- NpcBuildertalkTo(NpcLocations, DialogueNode)
Walks to and Talks to an NPC at a specified location and processes the dialogue.
- NpcBuildertalkTo(NpcLocations, String...)
Walks to and Talks to an NPC at a specified location and processes the dialogue.
- NpcBuildertrade(NpcLocations)
Walks to and Trades with an NPC at a specified location.
- NpcBuildervisit(NpcLocations, String)
Walks to and interacts with an NPC at a specified location.
Inherited from AbstractHandlerBuilder
- NpcBuilderadd(Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- NpcBuilderadd(Function<StepContext, Integer>)
Adds a step to the handler.
- NpcBuilderadd(Runnable)
Adds a step to the handler and assumes to return the next step number.
- NpcBuilderadd(Supplier<Integer>)
Adds a step to the handler.
- NpcBuilderadd(String, Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- NpcBuilderadd(String, Function<StepContext, Integer>)
Adds a step to the handler.
- NpcBuilderadd(String, Runnable)
Adds a step to the handler and assumes to return the next step number.
- NpcBuilderadd(String, Supplier<Integer>)
Adds a step to the handler.
- NpcBuilderaddDelay(int)
Adds a delay to the handler.
- NpcBuilderaddDelay(String, int)
Adds a delay to the handler.
- NpcBuilderaddDelayUntil(BooleanSupplier)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(Predicate<StepContext>)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(String, BooleanSupplier)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(String, Predicate<StepContext>)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(String, int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- NpcBuilderaddDelayUntil(String, int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- NpcBuilderappend(HandlerBuilder)
Appends a handler builder to the handler.
- NpcBuilderappend(StepHandler)
Appends a step handler to the handler.
- NpcBuilderappend(String, HandlerBuilder)
Appends a handler builder to the handler.
- NpcBuilderappend(String, StepHandler)
Appends a step handler to the handler.
- NpcBuilderwalkTo(WorldArea)
Adds a walk to step to the handler.
- NpcBuilderwalkTo(WorldPoint)
Adds a walk to step to the handler.
- NpcBuilderwalkTo(String, WorldArea)
Adds a walk to step to the handler.
- NpcBuilderwalkTo(String, WorldPoint)
Adds a walk to step to the handler.
- NpcBuilderwalkToWorldAreaSupplier(Supplier<WorldArea>)
Adds a walk to step to the handler.
- NpcBuilderwalkToWorldAreaSupplier(String, Supplier<WorldArea>)
Adds a walk to step to the handler.
- NpcBuilderwalkToWorldPointSupplier(Supplier<WorldPoint>)
Adds a walk to step to the handler.
- NpcBuilderwalkToWorldPointSupplier(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.
NpcBuilder()
public NpcBuilder()Creates a NpcBuilder.
attack(NpcLocations)
public NpcBuilder attack(NpcLocations npcLocations)Walks to and Attacks an NPC at a specified location.
Parameters
npcLocations- NpcLocations.
Returns
NpcBuilder instance.
get()static
public static NpcBuilder get()Creates a new instance of NpcBuilder.
Returns
A new NpcBuilder instance.
interact(String, String)
public NpcBuilder interact(String name, String action)Adds an interaction with an NPC to the handler.
Parameters
name- Name.
action- Action.
Returns
NpcBuilder instance.
talkTo(NpcLocations)
public NpcBuilder talkTo(NpcLocations npcLocations)Walks to and Talks to an NPC at a specified location.
Parameters
npcLocations- NpcLocations.
Returns
NpcBuilder instance.
talkTo(NpcLocations, DialogueNode)
public NpcBuilder talkTo(NpcLocations npcLocations, DialogueNode dialogueNode)Walks to and Talks to an NPC at a specified location and processes the dialogue.
Parameters
npcLocations- NpcLocations.
dialogueNode- DialogueNode.
Returns
NpcBuilder instance.
talkTo(NpcLocations, String...)
public NpcBuilder talkTo(NpcLocations npcLocations, String... chatOptions)Walks to and Talks to an NPC at a specified location and processes the dialogue.
Parameters
npcLocations- NpcLocations.
chatOptions- ChatOptions.
Returns
NpcBuilder instance.
trade(NpcLocations)
public NpcBuilder trade(NpcLocations npcLocations)Walks to and Trades with an NPC at a specified location.
Parameters
npcLocations- NpcLocations.
Returns
NpcBuilder instance.
visit(NpcLocations, String)
public NpcBuilder visit(NpcLocations npcLocations, String action)Walks to and interacts with an NPC at a specified location.
Parameters
npcLocations- NpcLocations.
action- Action.
Returns
NpcBuilder instance.
add(Consumer<StepContext>)from AbstractHandlerBuilder
public NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder addDelay(int delay)Adds a delay to the handler.
Parameters
delay- The delay in steps.
Returns
The HandlerBuilder.
addDelay(String, int)from AbstractHandlerBuilder
public NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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 NpcBuilder 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