Package net.openosrs.api.service.dialogue

Class DialogueFlowRunner

java.lang.Object

net.openosrs.api.service.dialogue.DialogueFlowRunner

All Implemented Interfaces:

java.lang.AutoCloseable

public class DialogueFlowRunner
extends java.lang.Object
implements java.lang.AutoCloseable

One owned, bounded dialogue sequence. Retain this handle over client ticks. COMPLETE means each submitted step produced a visible dialogue transition, not that a quest or transaction succeeded on the server.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
DialogueFlowRunner(DialogueService dialogue)	Deprecated.

Method Summary

Modifier and Type	Method	Description
DialogueFlowRunner.Status	advance()
static DialogueFlowRunner.Builder	builder(DialogueService dialogue)
void	cancel()
DialogueFlowRunner	choose(java.lang.String text)
DialogueFlowRunner	choose(java.lang.String expectedText, java.lang.String option)
void	close()
DialogueFlowRunner	continueIfPossible()
DialogueFlowRunner	continueStep()
DialogueFlowRunner	continueStep(java.lang.String expectedText)
DialogueFlowRunner	enterAmount(int amount)	Deprecated.
DialogueFlowRunner.Failure	getFailure()
DialogueFlowRunner.Status	getStatus()
boolean	isFinished()
static DialogueFlowRunner	of(DialogueService dialogue)
int	remaining()
void	reset()	Explicit restart of the same spec; never renews a stopped plugin owner.
DialogueFlowRunner	timeoutTicks(long ticks)

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogueFlowRunner

@Deprecated
@Inject
public DialogueFlowRunner(DialogueService dialogue)

Deprecated.

Legacy isolated handle. Prefer the factory with a plugin's OperationOwner.

Method Detail

of

public static DialogueFlowRunner of(DialogueService dialogue)

builder

public static DialogueFlowRunner.Builder builder(DialogueService dialogue)

continueStep

public DialogueFlowRunner continueStep()

continueStep

public DialogueFlowRunner continueStep(java.lang.String expectedText)

choose

public DialogueFlowRunner choose(java.lang.String expectedText,
                                 java.lang.String option)

continueIfPossible

public DialogueFlowRunner continueIfPossible()

choose

public DialogueFlowRunner choose(java.lang.String text)

enterAmount

@Deprecated
public DialogueFlowRunner enterAmount(int amount)

Deprecated.

timeoutTicks

public DialogueFlowRunner timeoutTicks(long ticks)

advance

public DialogueFlowRunner.Status advance()

getStatus

public DialogueFlowRunner.Status getStatus()

getFailure

public DialogueFlowRunner.Failure getFailure()

remaining

public int remaining()

isFinished

public boolean isFinished()

cancel

public void cancel()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

reset

public void reset()

Explicit restart of the same spec; never renews a stopped plugin owner.