script-sdk/org.tribot.script.sdk/ChatScreen

ChatScreen

Contains methods for inspecting and interacting with the dialog screen that appears over the chatbox, such as when talking to an NPC

Constructors

ChatScreen

constructor()

Types

Config

open class Config

The config for the chat handler.

Functions

clickContinue

open fun clickContinue(): Boolean

Attempts to click continue

containsMessage

open fun containsMessage(message: Array<String>): Boolean

Checks if any of the specified messages is contained in the current message

containsOption

open fun containsOption(options: Array<String>): Boolean

Checks if any available option contains any of the specified options.

containsText

open fun containsText(text: Array<String>): Boolean

Checks if the specified text is contained in any chat interface that is currently being displayed

getConfig

open fun getConfig(): ChatScreen.Config

Gets the current config for the chat screen handler

getMessage

open fun getMessage(): Optional<String>

Attempts to read the current message in the click continue window

getName

open fun getName(): Optional<String>

Attempts to read the name of the player/npc talking (the text at the top of the click continue interface)

getOptions

open fun getOptions(): List<String>

Gets all available chat screen options

handle

open fun handle(options: Array<String>): Boolean

open fun handle(stopCondition: BooleanSupplier, options: Array<String>): Boolean

Attempts to converse, selecting the specified options.

isClickContinueOpen

open fun isClickContinueOpen(): Boolean

Checks if the click continue interface dialog is open

isOpen

open fun isOpen(): Boolean

Checks if any chat screen is open

isSelectOptionOpen

open fun isSelectOptionOpen(): Boolean

Checks if the select option screen is open

selectOption

open fun selectOption(options: Array<String>): Boolean

Attempts to select an available option that contains any of the specified options.

open fun selectOption(filter: Predicate<String>): Boolean

Attempts to select an available option that matches the specified predicate

setConfig

open fun setConfig(config: ChatScreen.Config)

Sets the config for the chat screen handler