org.osbot.rs07.api

Class Dialogues

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Dialogues

public class Dialogues
extends API

Represents an API designed to handle dialogues in-game.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Dialogues()

Method Summary

Modifier and Type	Method and Description
boolean	clickContinue() Continues dialogue with a continuation message.
boolean	completeDialogue(java.lang.String... options) Completes the current dialogue using the specified options when available.
boolean	completeDialogueU(java.lang.String... options) Completes the current dialogue using the specified options when available.
int	getInterfaceId()
boolean	inDialogue() Checks if there is a dialogue currently active using color.
void	initializeModule()
boolean	isPendingContinuation() Determines whether the game is pending on a "to continue."
boolean	isPendingOption() Checks if the current dialogue has options for selection.
boolean	selectOption(int choice) Selects an option on the select an option menu in dialogues.
boolean	selectOption(int choices, int choice) Deprecated.
boolean	selectOption(java.lang.String... options) Selects an option from the option selection menu.

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

Dialogues

public Dialogues()

Method Detail

getInterfaceId

public int getInterfaceId()

clickContinue

public boolean clickContinue()

Continues dialogue with a continuation message.

Returns:

True if a dialogue has a continuation message and it was successfully clicked.

isPendingContinuation

public boolean isPendingContinuation()

Determines whether the game is pending on a "to continue."

Returns:

True if the game is pending on a "to continue."

inDialogue

public boolean inDialogue()

Checks if there is a dialogue currently active using color.

Returns:

True if there is an active dialogue.

isPendingOption

public boolean isPendingOption()

Checks if the current dialogue has options for selection.

Returns:

True if there is a dialogue interface with actions.

selectOption

@Deprecated
public boolean selectOption(int choices,
                                         int choice)

Deprecated.

Selects an option from the "Select an Option" menu. Note: Option dialogues do not have less than 2 choices or more than 5 choices.

Parameters:

choices - he amount of choices in the option selection dialogue

choice - The choice you wish to select. 1 is the first option.

selectOption

public boolean selectOption(int choice)

Selects an option on the select an option menu in dialogues.

Parameters:

choice - The index of the choice. 1 is the first option.

Returns:

True if successfully executed.

selectOption

public boolean selectOption(java.lang.String... options)

Selects an option from the option selection menu.

Parameters:

options - The options to choose if available.

Returns:

True if an option was successfully chosen.

completeDialogueU

public boolean completeDialogueU(java.lang.String... options)

Completes the current dialogue using the specified options when available.

WARNING - This method loops until either the player is not in a dialogue, the "Select an Option" menu does not contain any of the specified options, or an option selection event failed.

Parameters:

options - The options to choose while completing the dialogue.

Returns:

True if the player completed the dialogue successfully.

completeDialogue

public boolean completeDialogue(java.lang.String... options)
                         throws java.lang.InterruptedException

Completes the current dialogue using the specified options when available.

WARNING - This method loops until either the player is not in a dialogue, the "Select an Option" menu does not contain any of the specified options, or an option selection event failed.

Parameters:

options - The options to choose while completing the dialogue.

Returns:

True if the player completed the dialogue successfully.

Throws:

java.lang.InterruptedException - Thrown when interrupted during execution

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API