Class ScriptID


  • public final class ScriptID
    extends Object
    • 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
      • CHAT_SEND

        @ScriptArguments(integer=4,
                         string=1)
        public static final int CHAT_SEND
        Sends a chat message
        • String Message to send
        • int modes
        • int (clan type)
        • int (boolean) use target
        • int set target
        See Also:
        Constant Field Values
      • SPLITPM_CHANGED

        @ScriptArguments
        public static final int SPLITPM_CHANGED
        Rebuilds the chatbox and the pmbox
        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=3)
        public static final int MESSAGE_LAYER_CLOSE
        Closes the chatbox input
        • int (boolean) Clear the current text
        • int (boolean) Restore to chat view
        • int (boolean) Submit close to server
        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
      • QUEST_UPDATE_LINECOUNT

        @ScriptArguments(integer=2)
        public static final int QUEST_UPDATE_LINECOUNT
        Updates the Quest interface's scrollbar
        • int (boolean) Reset scroll position
        • int Number of lines
        See Also:
        Constant Field Values
      • DIARY_UPDATE_LINECOUNT

        @ScriptArguments(integer=2)
        public static final int DIARY_UPDATE_LINECOUNT
        Updates the Diary 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
        @Deprecated
        public static final int NULL
        Deprecated.
        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
      • CLAN_SIDEPANEL_DRAW

        @ScriptArguments(integer=7)
        public static final int CLAN_SIDEPANEL_DRAW
        Builds the widget that holds all of the players inside a clan chat
        See Also:
        Constant Field Values
      • GE_OFFERS_SETUP_BUILD

        @ScriptArguments(integer=17)
        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_INIT

        @ScriptArguments(integer=8)
        public static final int QUESTLIST_INIT
        On load listener for building the quest list interface
        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_INIT

        @ScriptArguments(integer=34)
        public static final int BANKMAIN_INIT
        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
      • BANKMAIN_SIZE_CHECK

        @ScriptArguments(integer=6)
        public static final int BANKMAIN_SIZE_CHECK
        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
      • ZOOM_SLIDER_ONDRAG

        @ScriptArguments(integer=3)
        public static final int ZOOM_SLIDER_ONDRAG
        Drag callback for the camera zoom slider in the options side panel.
        See Also:
        Constant Field Values
      • SETTINGS_ZOOM_SLIDER_ONDRAG

        @ScriptArguments(integer=6)
        public static final int SETTINGS_ZOOM_SLIDER_ONDRAG
        Drag callback for the camera zoom slider in the settings.
        See Also:
        Constant Field Values
      • COLLECTION_DRAW_LIST

        @ScriptArguments(integer=6)
        public static final int COLLECTION_DRAW_LIST
        See Also:
        Constant Field Values
      • NOTIFICATION_START

        @ScriptArguments(integer=3)
        public static final int NOTIFICATION_START
        Draws the active notification in increasing sizes (increasing horizontally first, then vertically) to show a starting animation.
        See Also:
        Constant Field Values
      • NOTIFICATION_DELAY

        @ScriptArguments(integer=1)
        public static final int NOTIFICATION_DELAY
        Draws the active notification in full size for a specified number of client ticks. In essence, delayed between the open and close animations.
        See Also:
        Constant Field Values
      • GROUP_IRONMAN_STORAGE_BUILD

        @ScriptArguments(integer=7)
        public static final int GROUP_IRONMAN_STORAGE_BUILD
        See Also:
        Constant Field Values
      • INVENTORY_DRAWITEM

        @ScriptArguments(integer=6)
        public static final int INVENTORY_DRAWITEM
        See Also:
        Constant Field Values
      • TRADE_MAIN_INIT

        @ScriptArguments(integer=6)
        public static final int TRADE_MAIN_INIT
        Initializes the trade interface
        See Also:
        Constant Field Values
      • TOB_HUD_SOTETSEG_FADE

        @ScriptArguments(string=1)
        public static final int TOB_HUD_SOTETSEG_FADE
        Transitions the tob hud into the white flash that happens when sotetseg teleports the players to the maze.
        See Also:
        Constant Field Values
      • RAIDS_STORAGE_PRIVATE_ITEMS

        @ScriptArguments(integer=3)
        public static final int RAIDS_STORAGE_PRIVATE_ITEMS
        See Also:
        Constant Field Values
      • HP_HUD_UPDATE

        @ScriptArguments(integer=12)
        public static final int HP_HUD_UPDATE
        See Also:
        Constant Field Values
      • ORBS_UPDATE_RUNENERGY

        @ScriptArguments(integer=7)
        public static final int ORBS_UPDATE_RUNENERGY
        See Also:
        Constant Field Values
      • WORLDMAP_LOADMAP

        @ScriptArguments(integer=9)
        public static final int WORLDMAP_LOADMAP
        See Also:
        Constant Field Values
      • PRAYER_UPDATEBUTTON

        @ScriptArguments(integer=5)
        public static final int PRAYER_UPDATEBUTTON
        See Also:
        Constant Field Values
      • PRAYER_REDRAW

        @ScriptArguments(integer=9,
                         string=2)
        public static final int PRAYER_REDRAW
        See Also:
        Constant Field Values
      • QUICKPRAYER_INIT

        @ScriptArguments(integer=3)
        public static final int QUICKPRAYER_INIT
        See Also:
        Constant Field Values
      • ADD_OVERLAYTIMER_LOC

        @ScriptArguments(integer=7)
        public static final int ADD_OVERLAYTIMER_LOC
        Called to add a loc overlay timer
        • loc coord
        • loc id
        • loc type
        • overlay type
        • overlay ticks
        See Also:
        Constant Field Values
      • ACCOUNT_SUMMARY_TEXT_FORMAT

        @ScriptArguments(integer=7,
                         string=1)
        public static final int ACCOUNT_SUMMARY_TEXT_FORMAT
        See Also:
        Constant Field Values
      • ACCOUNT_SUMMARY_SECTION_FORMAT

        @ScriptArguments(integer=10,
                         string=3)
        public static final int ACCOUNT_SUMMARY_SECTION_FORMAT
        See Also:
        Constant Field Values
      • CHATBOX_KEYINPUT_MATCHED

        @ScriptArguments(integer=6,
                         string=2)
        public static final int CHATBOX_KEYINPUT_MATCHED
        See Also:
        Constant Field Values
      • EQUIPMENT_SET_STAT_BONUS_SETUP

        @ScriptArguments(integer=6)
        public static final int EQUIPMENT_SET_STAT_BONUS_SETUP
        See Also:
        Constant Field Values
      • MAGIC_SPELLBOOK_INITIALISESPELLS

        @ScriptArguments(integer=12,
                         string=2)
        public static final int MAGIC_SPELLBOOK_INITIALISESPELLS
        See Also:
        Constant Field Values
    • Constructor Detail

      • ScriptID

        public ScriptID()