net.runelite.api

Class ScriptID

java.lang.Object

net.runelite.api.ScriptID

public final class ScriptID
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUILD_CHATBOX Rebuilds the chatbox
static int	CAMERA_DO_ZOOM Handles zoom input Updates the VarClientInts (73, 74) to this same value int Reset zoom position int Reset zoom position
static int	CHAT_PROMPT_INIT Builds the chatbox input widget
static int	CHAT_TEXT_INPUT_REBUILD Rebuilds the text input widget inside the chat interface String Message Prefix.
static int	CHATBOX_INPUT Sends a chat message int (byte) Flags String Message to send
static int	CLAN_SEND_KICK Attempts to kick the specified player from the Clan Chat String Players in-game name
static int	DEATH_KEEP_ITEM_EXAMINE Displays the game messages when clicking on an item inside the Items Kept on Death interface int (boolean) Item kept on death int Item Quantity String Item Name
static int	DIARY_QUEST_UPDATE_LINECOUNT Updates the Diary/Quest interface's scrollbar int (boolean) Reset scroll position int Number of lines
static int	MESSAGE_LAYER_CLOSE Closes the chatbox input int (boolean) Clear the current text int (boolean) Restore to chat view
static int	MESSAGE_LAYER_OPEN Readies the chatbox panel for things like the chatbox input Inverse of MESSAGE_LAYER_CLOSE int (InputType) message layer type we are changing to
static int	NULL Does nothing This is used to eat events when you want a menu action attached to it because you need an op listener attached to it for it to work
static int	OPEN_PRIVATE_MESSAGE_INTERFACE Opens the Private Message chat interface Jagex refers to this script as meslayer_mode6 String Player to send private message to
static int	OPTIONS_ALLSOUNDS Sets the background for sound option bars int Value of the slider (0-4) int (WidgetID) * 5, segments of the slider
static int	PRIVMSG Send a private message.
static int	QUESTLIST_PROGRESS Queries the completion state of a quest by its struct id int (struct) The id of the quest Returns int (QuestState) the normalized state of the quest
static int	UPDATE_SCROLLBAR Updates the scrollbar handle and container to the new height of the content container int (WidgetID) Scrollbar's widget ID int (WidgetID) Container widget ID int how far down to scroll
static int	WATSON_STASH_UNIT_CHECK Checks the state of the given stash unit.
static int	XPDROP_DISABLED Creates a disabled experience drop int (Skill ordinal) Sets what icon to use int Amount of exp to drop

Constructor Summary

Constructors

Constructor and Description
ScriptID()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_SCROLLBAR

@ScriptArguments(integer=3)
public static final int UPDATE_SCROLLBAR

Updates the scrollbar handle and container to the new height of the content container

• int (WidgetID) Scrollbar's widget ID
• int (WidgetID) Container widget ID
• int how far down to scroll

See Also:

Constant Field Values

CHATBOX_INPUT

@ScriptArguments(integer=1,
                 string=1)
public static final int CHATBOX_INPUT

Sends a chat message

• int (byte) Flags
• String Message to send

See Also:

Constant Field Values

BUILD_CHATBOX

@ScriptArguments
public static final int BUILD_CHATBOX

Rebuilds the chatbox

See Also:

Constant Field Values

OPEN_PRIVATE_MESSAGE_INTERFACE

@ScriptArguments(string=1)
public static final int OPEN_PRIVATE_MESSAGE_INTERFACE

Opens the Private Message chat interface Jagex refers to this script as meslayer_mode6

• String Player to send private message to

See Also:

Constant Field Values

CHAT_TEXT_INPUT_REBUILD

@ScriptArguments(string=1)
public static final int CHAT_TEXT_INPUT_REBUILD

Rebuilds the text input widget inside the chat interface

• String Message Prefix. Only used inside the GE search interfaces

See Also:

Constant Field Values

MESSAGE_LAYER_CLOSE

@ScriptArguments(integer=2)
public static final int MESSAGE_LAYER_CLOSE

Closes the chatbox input

• int (boolean) Clear the current text
• int (boolean) Restore to chat view

See Also:

Constant Field Values

OPTIONS_ALLSOUNDS

@ScriptArguments(integer=6)
public static final int OPTIONS_ALLSOUNDS

Sets the background for sound option bars

• int Value of the slider (0-4)
• int (WidgetID) * 5, segments of the slider

See Also:

Constant Field Values

MESSAGE_LAYER_OPEN

@ScriptArguments(integer=1)
public static final int MESSAGE_LAYER_OPEN

Readies the chatbox panel for things like the chatbox input Inverse of MESSAGE_LAYER_CLOSE

• int (InputType) message layer type we are changing to

See Also:

Constant Field Values

CHAT_PROMPT_INIT

@ScriptArguments
public static final int CHAT_PROMPT_INIT

Builds the chatbox input widget

See Also:

Constant Field Values

DEATH_KEEP_ITEM_EXAMINE

@ScriptArguments(integer=2,
                 string=1)
public static final int DEATH_KEEP_ITEM_EXAMINE

Displays the game messages when clicking on an item inside the Items Kept on Death interface

• int (boolean) Item kept on death
• int Item Quantity
• String Item Name

See Also:

Constant Field Values

WATSON_STASH_UNIT_CHECK

@ScriptArguments(integer=4)
public static final int WATSON_STASH_UNIT_CHECK

Checks the state of the given stash unit.

• int (loc) The stash unit object id
• int Bitpacked stash unit states
• int Bitpacked stash unit states 2
• int Bitpacked stash unit states 3

Returns a pair of booleans indicating if the stash unit is built and if it is filled

See Also:

Constant Field Values

QUESTLIST_PROGRESS

@ScriptArguments(integer=1)
public static final int QUESTLIST_PROGRESS

Queries the completion state of a quest by its struct id

• int (struct) The id of the quest

Returns

• int (QuestState) the normalized state of the quest

See Also:

Constant Field Values

DIARY_QUEST_UPDATE_LINECOUNT

@ScriptArguments(integer=2)
public static final int DIARY_QUEST_UPDATE_LINECOUNT

Updates the Diary/Quest interface's scrollbar

• int (boolean) Reset scroll position
• int Number of lines

See Also:

Constant Field Values

CAMERA_DO_ZOOM

@ScriptArguments(integer=2)
public static final int CAMERA_DO_ZOOM

Handles zoom input Updates the VarClientInts (73, 74) to this same value

• int Reset zoom position
• int Reset zoom position

See Also:

Constant Field Values

NULL

@ScriptArguments
public static final int NULL

Does nothing This is used to eat events when you want a menu action attached to it because you need an op listener attached to it for it to work

See Also:

Constant Field Values

PRIVMSG

@ScriptArguments(string=2)
public static final int PRIVMSG

Send a private message.

See Also:

Constant Field Values

XPDROP_DISABLED

@ScriptArguments(integer=2)
public static final int XPDROP_DISABLED

Creates a disabled experience drop

• int (Skill ordinal) Sets what icon to use
• int Amount of exp to drop

See Also:

Constant Field Values

CLAN_SEND_KICK

@ScriptArguments(string=1)
public static final int CLAN_SEND_KICK

Attempts to kick the specified player from the Clan Chat

• String Players in-game name

See Also:

Constant Field Values

Constructor Detail

ScriptID

public ScriptID()