TileObjectBuilder
Builder for handling interactions with tile objects in the game world.
ClassRLPlugins API
public class TileObjectBuilder extends AbstractHandlerBuilder<TileObjectBuilder>Constants
END_EXECUTION
Members
Constructors
- newTileObjectBuilder()
Creates a TileObjectBuilder.
Methods
- TileObjectBuilderget()
Creates a new instance of TileObjectBuilder.
- TileObjectBuilderinteract(String, String)
Interacts with the specified object using the given action.
- TileObjectBuilderinteract(String, String, DialogueNode)
Interacts with the specified object using the given action and handles dialogue.
- TileObjectBuilderinteract(String, String, String...)
Interacts with the specified object using the given action and handles dialogue.
- TileObjectBuildervisit(WorldPoint, String, String)
Walks to the specified world point and interacts with the specified object.
- TileObjectBuildervisit(WorldPoint, String, String, DialogueNode)
Walks to the specified world point and interacts with the specified object.
- TileObjectBuildervisit(WorldPoint, String, String, String...)
Walks to the specified world point and interacts with the specified object.
Inherited from AbstractHandlerBuilder
- TileObjectBuilderadd(Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- TileObjectBuilderadd(Function<StepContext, Integer>)
Adds a step to the handler.
- TileObjectBuilderadd(Runnable)
Adds a step to the handler and assumes to return the next step number.
- TileObjectBuilderadd(Supplier<Integer>)
Adds a step to the handler.
- TileObjectBuilderadd(String, Consumer<StepContext>)
Adds a step to the handler and assumes to return the next step number.
- TileObjectBuilderadd(String, Function<StepContext, Integer>)
Adds a step to the handler.
- TileObjectBuilderadd(String, Runnable)
Adds a step to the handler and assumes to return the next step number.
- TileObjectBuilderadd(String, Supplier<Integer>)
Adds a step to the handler.
- TileObjectBuilderaddDelay(int)
Adds a delay to the handler.
- TileObjectBuilderaddDelay(String, int)
Adds a delay to the handler.
- TileObjectBuilderaddDelayUntil(BooleanSupplier)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(Predicate<StepContext>)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(String, BooleanSupplier)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(String, Predicate<StepContext>)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(String, int, BooleanSupplier, Runnable)
Adds a delay until a condition is met.
- TileObjectBuilderaddDelayUntil(String, int, Predicate<StepContext>, Consumer<StepContext>)
Adds a delay until a condition is met.
- TileObjectBuilderappend(HandlerBuilder)
Appends a handler builder to the handler.
- TileObjectBuilderappend(StepHandler)
Appends a step handler to the handler.
- TileObjectBuilderappend(String, HandlerBuilder)
Appends a handler builder to the handler.
- TileObjectBuilderappend(String, StepHandler)
Appends a step handler to the handler.
- TileObjectBuilderwalkTo(WorldArea)
Adds a walk to step to the handler.
- TileObjectBuilderwalkTo(WorldPoint)
Adds a walk to step to the handler.
- TileObjectBuilderwalkTo(String, WorldArea)
Adds a walk to step to the handler.
- TileObjectBuilderwalkTo(String, WorldPoint)
Adds a walk to step to the handler.
- TileObjectBuilderwalkToWorldAreaSupplier(Supplier<WorldArea>)
Adds a walk to step to the handler.
- TileObjectBuilderwalkToWorldAreaSupplier(String, Supplier<WorldArea>)
Adds a walk to step to the handler.
- TileObjectBuilderwalkToWorldPointSupplier(Supplier<WorldPoint>)
Adds a walk to step to the handler.
- TileObjectBuilderwalkToWorldPointSupplier(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.
TileObjectBuilder()
public TileObjectBuilder()Creates a TileObjectBuilder.
get()static
public static TileObjectBuilder get()Creates a new instance of TileObjectBuilder.
Returns
A new TileObjectBuilder instance.
interact(String, String)
public TileObjectBuilder interact(String objectName, String action)Interacts with the specified object using the given action.
Parameters
objectName- The name of the object to interact with.
action- The action to perform on the object.
Returns
TileObjectBuilder instance.
interact(String, String, DialogueNode)
public TileObjectBuilder interact(String objectName, String action, DialogueNode node)Interacts with the specified object using the given action and handles dialogue.
Parameters
objectName- The name of the object to interact with.
action- The action to perform on the object.
node- The dialogue node to handle after interaction.
Returns
TileObjectBuilder instance.
interact(String, String, String...)
public TileObjectBuilder interact(String objectName, String action, String... dialogueOptions)Interacts with the specified object using the given action and handles dialogue.
Parameters
objectName- The name of the object to interact with.
action- The action to perform on the object.
dialogueOptions- The dialogue options to handle after interaction.
Returns
TileObjectBuilder instance.
visit(WorldPoint, String, String)
public TileObjectBuilder visit(WorldPoint worldPoint, String objectName, String action)Walks to the specified world point and interacts with the specified object.
Parameters
worldPoint- The world point to walk to.
objectName- The name of the object to interact with.
action- The action to perform on the object.
Returns
TileObjectBuilder instance.
visit(WorldPoint, String, String, DialogueNode)
public TileObjectBuilder visit(WorldPoint worldPoint, String objectName, String action, DialogueNode node)Walks to the specified world point and interacts with the specified object.
Parameters
worldPoint- The world point to walk to.
objectName- The name of the object to interact with.
action- The action to perform on the object.
node- The dialogue node to handle after interaction.
Returns
TileObjectBuilder instance.
visit(WorldPoint, String, String, String...)
public TileObjectBuilder visit(WorldPoint worldPoint, String objectName, String action, String... dialogueOptions)Walks to the specified world point and interacts with the specified object.
Parameters
worldPoint- The world point to walk to.
objectName- The name of the object to interact with.
action- The action to perform on the object.
dialogueOptions- The dialogue options to handle after interaction.
Returns
TileObjectBuilder instance.
add(Consumer<StepContext>)from AbstractHandlerBuilder
public TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder addDelay(int delay)Adds a delay to the handler.
Parameters
delay- The delay in steps.
Returns
The HandlerBuilder.
addDelay(String, int)from AbstractHandlerBuilder
public TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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 TileObjectBuilder 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