java.lang.Object
- net.runelite.api.ScriptID

public final class ScriptID
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BANKMAIN_BUILD`	Main layout script for the bank int (WidgetID) * 17, various widgets making up the bank interface
`static int`	`BANKMAIN_FINISHBUILDING`
`static int`	`BANKMAIN_SEARCH_REFRESH`	Called in an onTimer, determines whether to layout the bank during a search int (WidgetID) * 16, various widgets making up the bank interface
`static int`	`BANKMAIN_SEARCH_TOGGLE`	Toggles the bank search int 1 (must be 1 or script immediately returns) Also takes 17 widget IDs corresponding to various bank widgets.
`static int`	`BANKMAIN_SEARCHING`
`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 for fixed viewport mode int Reset zoom position for resizable viewport mode
`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`	`COMBAT_INTERFACE_SETUP`	Called to build the combat interface
`static int`	`DIARY_QUEST_UPDATE_LINECOUNT`	Updates the Diary/Quest interface's scrollbar int (boolean) Reset scroll position int Number of lines
`static int`	`FRIENDS_CHAT_CHANNEL_REBUILD`	Builds the widget that holds all of the players inside a friends chat
`static int`	`FRIENDS_CHAT_SEND_KICK`	Attempts to kick the specified player from the friends chat String Players in-game name
`static int`	`FRIENDS_UPDATE`	Called when the friends list is updated int (WidgetID) Friends list "full container" int (WidgetID) Friends list sort by name button int (WidgetID) Friends list sort by last world change button int (WidgetID) Friends list sort by world button int (WidgetID) Friends list legacy sort button int (WidgetID) Friends list names container int (WidgetID) Friends list scroll bar int (WidgetID) Friends list "loading please wait" text int (WidgetID) Friends list player previous name holder
`static int`	`GE_ITEM_SEARCH`	Builds the grand exchange item search widget
`static int`	`GE_OFFERS_SETUP_BUILD`	Builds the widget for making an offer in Grand Exchange
`static int`	`IGNORE_UPDATE`	Called when the ignore list is updated int (WidgetID) Ignore list "full container" int (WidgetID) Ignore list sort by name button int (WidgetID) Ignore list legacy sort button int (WidgetID) Ignore list names container int (WidgetID) Ignore list scroll bar int (WidgetID) Ignore list "loading please wait" text int (WidgetID) Ignore list player previous name holder
`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`	`PRIVMSG`	Send a private message.
`static int`	`PVP_WIDGET_BUILDER`	Called to update the PVP widget (wilderness level/protection)
`static int`	`QUEST_STATUS_GET`	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`	`QUESTLIST_PROGRESS_LIST_SHOW`	Builds the quest list inside the quest tab that shows each quest's progress
`static int`	`SETTINGS_SLIDER_CHOOSE_ONOP`	Chooses the click handler for a `ParamID.SETTING_SLIDER_CUSTOM_ONOP` = 1 settings slider The active widget is set to the track created by `ParamID.SETTING_FOREGROUND_CLICKZONE` int `ParamID.SETTING_ID` int (WidgetID) Slider handle ID int (widget index) Slider handle index int track width int y offset int x offset int (WidgetID) drag parent
`static int`	`TOPLEVEL_REDRAW`	Called to build the toplevel interface
`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`	`WIKI_ICON_UPDATE`	Position and size the wiki button, as well as hide/unhide it
`static int`	`XPDROP_DISABLED`	Creates a disabled experience drop int (Skill ordinal) Sets what icon to use int Amount of exp to drop
`static int`	`XPDROPS_SETDROPSIZE`	Called to set position of an xpdrop text and sprite(s) XP drop parent component

Constructor Summary

Constructors
Constructor 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
  - 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
  - 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
  - QUEST_STATUS_GET
```
@ScriptArguments(integer=1)
public static final int QUEST_STATUS_GET
```
    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 for fixed viewport mode
    
    int Reset zoom position for resizable viewport mode
    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
  - FRIENDS_CHAT_SEND_KICK
```
@ScriptArguments(string=1)
public static final int FRIENDS_CHAT_SEND_KICK
```
    Attempts to kick the specified player from the friends chat
    
    String Players in-game name
    See Also:
    
    Constant Field Values
  - FRIENDS_CHAT_CHANNEL_REBUILD
```
@ScriptArguments(integer=15)
public static final int FRIENDS_CHAT_CHANNEL_REBUILD
```
    Builds the widget that holds all of the players inside a friends chat
    
    See Also:
    
    Constant Field Values
  - GE_OFFERS_SETUP_BUILD
```
@ScriptArguments(integer=15)
public static final int GE_OFFERS_SETUP_BUILD
```
    Builds the widget for making an offer in Grand Exchange
    
    See Also:
    
    Constant Field Values
  - GE_ITEM_SEARCH
```
@ScriptArguments(integer=3)
public static final int GE_ITEM_SEARCH
```
    Builds the grand exchange item search widget
    
    See Also:
    
    Constant Field Values
  - QUESTLIST_PROGRESS_LIST_SHOW
```
@ScriptArguments(integer=3)
public static final int QUESTLIST_PROGRESS_LIST_SHOW
```
    Builds the quest list inside the quest tab that shows each quest's progress
    
    See Also:
    
    Constant Field Values
  - FRIENDS_UPDATE
```
@ScriptArguments(integer=9)
public static final int FRIENDS_UPDATE
```
    Called when the friends list is updated
    
    int (WidgetID) Friends list "full container"
    
    int (WidgetID) Friends list sort by name button
    
    int (WidgetID) Friends list sort by last world change button
    
    int (WidgetID) Friends list sort by world button
    
    int (WidgetID) Friends list legacy sort button
    
    int (WidgetID) Friends list names container
    
    int (WidgetID) Friends list scroll bar
    
    int (WidgetID) Friends list "loading please wait" text
    
    int (WidgetID) Friends list player previous name holder
    See Also:
    
    Constant Field Values
  - IGNORE_UPDATE
```
@ScriptArguments(integer=7)
public static final int IGNORE_UPDATE
```
    Called when the ignore list is updated
    
    int (WidgetID) Ignore list "full container"
    
    int (WidgetID) Ignore list sort by name button
    
    int (WidgetID) Ignore list legacy sort button
    
    int (WidgetID) Ignore list names container
    
    int (WidgetID) Ignore list scroll bar
    
    int (WidgetID) Ignore list "loading please wait" text
    
    int (WidgetID) Ignore list player previous name holder
    See Also:
    
    Constant Field Values
  - BANKMAIN_SEARCH_REFRESH
```
@ScriptArguments(integer=17)
public static final int BANKMAIN_SEARCH_REFRESH
```
    Called in an onTimer, determines whether to layout the bank during a search
    
    int (WidgetID) * 16, various widgets making up the bank interface
    See Also:
    
    Constant Field Values
  - PVP_WIDGET_BUILDER
```
@ScriptArguments(integer=1)
public static final int PVP_WIDGET_BUILDER
```
    Called to update the PVP widget (wilderness level/protection)
    
    See Also:
    
    Constant Field Values
  - COMBAT_INTERFACE_SETUP
```
@ScriptArguments
public static final int COMBAT_INTERFACE_SETUP
```
    Called to build the combat interface
    
    See Also:
    
    Constant Field Values
  - TOPLEVEL_REDRAW
```
@ScriptArguments(integer=2)
public static final int TOPLEVEL_REDRAW
```
    Called to build the toplevel interface
    
    See Also:
    
    Constant Field Values
  - XPDROPS_SETDROPSIZE
```
@ScriptArguments(integer=4,
                 string=1)
public static final int XPDROPS_SETDROPSIZE
```
    Called to set position of an xpdrop text and sprite(s)
    
    XP drop parent component
    See Also:
    
    Constant Field Values
  - BANKMAIN_BUILD
```
@ScriptArguments(integer=17)
public static final int BANKMAIN_BUILD
```
    Main layout script for the bank
    
    int (WidgetID) * 17, various widgets making up the bank interface
    See Also:
    
    Constant Field Values
  - BANKMAIN_FINISHBUILDING
```
@ScriptArguments(integer=19)
public static final int BANKMAIN_FINISHBUILDING
```
    See Also:
    
    Constant Field Values
  - BANKMAIN_SEARCHING
```
@ScriptArguments
public static final int BANKMAIN_SEARCHING
```
    See Also:
    
    Constant Field Values
  - BANKMAIN_SEARCH_TOGGLE
```
@ScriptArguments(integer=18)
public static final int BANKMAIN_SEARCH_TOGGLE
```
    Toggles the bank search
    
    int 1 (must be 1 or script immediately returns)
    
    Also takes 17 widget IDs corresponding to various bank widgets. These can be retrieved from the onInvTransmitListener of BANK_ITEM_CONTAINER. Note that this array also contains the script ID for the bank layout script in the first index
    See Also:
    
    Constant Field Values
  - SETTINGS_SLIDER_CHOOSE_ONOP
```
@ScriptArguments(integer=8,
                 string=1)
public static final int SETTINGS_SLIDER_CHOOSE_ONOP
```
    Chooses the click handler for a ParamID.SETTING_SLIDER_CUSTOM_ONOP = 1 settings slider The active widget is set to the track created by ParamID.SETTING_FOREGROUND_CLICKZONE
    
    int ParamID.SETTING_ID
    
    int (WidgetID) Slider handle ID
    
    int (widget index) Slider handle index
    
    int track width
    
    int y offset
    
    int x offset
    
    int (WidgetID) drag parent
    See Also:
    
    Constant Field Values
  - WIKI_ICON_UPDATE
```
@ScriptArguments(integer=4)
public static final int WIKI_ICON_UPDATE
```
    Position and size the wiki button, as well as hide/unhide it
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ScriptID
```
public ScriptID()
```

Class ScriptID

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UPDATE_SCROLLBAR

CHATBOX_INPUT

BUILD_CHATBOX

OPEN_PRIVATE_MESSAGE_INTERFACE

CHAT_TEXT_INPUT_REBUILD

MESSAGE_LAYER_CLOSE

MESSAGE_LAYER_OPEN

CHAT_PROMPT_INIT

WATSON_STASH_UNIT_CHECK

QUEST_STATUS_GET

DIARY_QUEST_UPDATE_LINECOUNT

CAMERA_DO_ZOOM

NULL

PRIVMSG

XPDROP_DISABLED

FRIENDS_CHAT_SEND_KICK

FRIENDS_CHAT_CHANNEL_REBUILD

GE_OFFERS_SETUP_BUILD

GE_ITEM_SEARCH

QUESTLIST_PROGRESS_LIST_SHOW

FRIENDS_UPDATE

IGNORE_UPDATE

BANKMAIN_SEARCH_REFRESH

PVP_WIDGET_BUILDER

COMBAT_INTERFACE_SETUP

TOPLEVEL_REDRAW

XPDROPS_SETDROPSIZE

BANKMAIN_BUILD

BANKMAIN_FINISHBUILDING

BANKMAIN_SEARCHING

BANKMAIN_SEARCH_TOGGLE

SETTINGS_SLIDER_CHOOSE_ONOP

WIKI_ICON_UPDATE

Constructor Detail

ScriptID