Package net.openosrs.api.service.dialogue

Class DialogueFlowRunner

java.lang.Object

net.openosrs.api.service.dialogue.DialogueFlowRunner

@Singleton
public class DialogueFlowRunner
extends java.lang.Object

Executes ordered dialogue interactions until an end condition. Steps are matched against LIVE dialogue state: a step that cannot run right now is simply skipped when the dialogue no longer matches (NPCs vary), while an explicit expectation failure fails the flow.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DialogueFlowRunner.Builder
static class	DialogueFlowRunner.Status
static class	DialogueFlowRunner.Step
static class	DialogueFlowRunner.StepKind

Constructor Summary

Constructors

Constructor	Description
DialogueFlowRunner(DialogueService dialogue)

Method Summary

Modifier and Type	Method	Description
DialogueFlowRunner.Status	advance()	Execute one step per tick.
static DialogueFlowRunner.Builder	builder(DialogueService dialogue)	Declarative builder entry point used by plugin code.
DialogueFlowRunner	choose(java.lang.String optionNeedle)
DialogueFlowRunner	continueIfPossible()	Alias matching the declarative flow vocabulary.
DialogueFlowRunner	continueStep()
DialogueFlowRunner	enterAmount(int amount)
boolean	isFinished()
static DialogueFlowRunner	of(DialogueService dialogue)
int	remaining()	Remaining step count (diagnostics).
void	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogueFlowRunner

@Inject
public DialogueFlowRunner(DialogueService dialogue)

Method Detail

of

public static DialogueFlowRunner of(DialogueService dialogue)

builder

public static DialogueFlowRunner.Builder builder(DialogueService dialogue)

Declarative builder entry point used by plugin code.

continueStep

public DialogueFlowRunner continueStep()

choose

public DialogueFlowRunner choose(java.lang.String optionNeedle)

enterAmount

public DialogueFlowRunner enterAmount(int amount)

continueIfPossible

public DialogueFlowRunner continueIfPossible()

Alias matching the declarative flow vocabulary.

advance

public DialogueFlowRunner.Status advance()

Execute one step per tick.

Returns:

current status; COMPLETE once every step has been consumed and the dialogue either resolved or moved past the last step.

remaining

public int remaining()

Remaining step count (diagnostics).

isFinished

public boolean isFinished()

reset

public void reset()