DeadZone Community Packages
    Preparing search index...

    Enumeration GameEventType

    Contains a reference to all the game events. To use an event, copy the event name and define your own function making sure to include required parameters. Events are important for reacting to what is changing in the game. For example, if you wanted to equip an item when the player animation changes to a specific one. You may use the OnAnimationChanged event to listen for the change instead of checking the player's animation each game tick. We recommend using the param decorator when data is required in an event as it provides clarity on what the event data represents inside the editor. In addition, you can right-click inside the editor -> Command Palette and search for the event name to insert a definition automatically

    See how you can "subscribe" to a Runelite Event which takes an event parameter. Replace param below with a multi-line comment for editor type support

    // @param {ChatMessage} event
    function OnChatMessage(event) {
       if (event.getType() == ChatMessageType.GAMEMESSAGE) {
           Utility.print(event.getMessage());
       }
    }
    Index

    Enumeration Members

    OnActorDeath OnAnimationChanged OnChatMessage OnClientTick OnDecorativeObjectDespawned OnDecorativeObjectSpawned OnFakeXPDrop OnGameObjectDespawned OnGameObjectSpawned OnGameStateChanged OnGameTick OnGraphicsObjectCreated OnGroundObjectDespawned OnGroundObjectSpawned OnHitsplatApplied OnInteractingChanged OnItemContainerChanged OnItemDespawned OnItemSpawned OnKeyPressed OnMenuEntryAdded OnMenuOpened OnMenuOptionClicked OnPlayerDespawned OnPlayerSpawned OnProjectileMoved OnShutdown OnStart OnStatChanged OnVarbitChanged OnWallObjectDespawned OnWallObjectSpawned OnWidgetLoaded

    Enumeration Members

    OnActorDeath: 10

    Called when a Actor has died such as an Npc or Player

    ActorDeath

    OnAnimationChanged: 5

    Called when an animation changes on any Actor

    OnAnimationChanged

    OnChatMessage: 3

    Called everytime a chat message is sent in the game chat

    ChatMessage

    OnClientTick: 21

    Called each client tick which is roughly every 20ms. Shouldn't be used for extensive logical operations, reserve for GameTick

    OnDecorativeObjectDespawned: 18

    Called when a Decorative Object is removed or is no longer within render range

    DecorativeObjectDespawned

    OnDecorativeObjectSpawned: 17

    Called when a Decorative Object is created or became visible within render distance

    DecorativeObjectSpawned

    OnFakeXPDrop: 26

    Called when LocalPlayer's has received a "fake" XP drop which doesn't have any impact on stats.

    FakeXPDrop

    OnGameObjectDespawned: 12

    Called when a Game Object is removed or is no longer within render range

    GameObjectDespawned

    OnGameObjectSpawned: 11

    Called when a Game Object is created or became visible within render range

    GameObjectSpawned

    OnGameStateChanged: 4

    Called when the game state changes such as logging in, changing worlds, loading etc

    GameStateChanged

    OnGameTick: 1

    Called every game tick which is roughly 0.6s on the client thread

    OnGraphicsObjectCreated: 22

    Called when a Graphics Object is created or became visible within render distance

    GraphicsObjectCreated

    OnGroundObjectDespawned: 14

    Called when a Ground Object is removed or is no longer within render range

    GroundObjectDespawned

    OnGroundObjectSpawned: 13

    Called when a Ground Object is created or became visible within render distance

    GroundObjectSpawned

    OnHitsplatApplied: 25

    Called when an Actor has recieved HitSplat damage

    HitsplatApplied

    OnInteractingChanged: 31

    Called when an Actor's interacting has changed

    InteractingChanged

    OnItemContainerChanged: 27

    Called when an ItemContainer has changed such as your inventory or bank etc..

    ItemContainerChanged

    OnItemDespawned: 30

    Called when an TileItem has despawned

    ItemDespawned

    OnItemSpawned: 29

    Called when an TileItem has spawned

    ItemSpawned

    OnKeyPressed: 32

    Called when a key is pressed down

    Keycode which has been pressed

    OnMenuEntryAdded: 19

    Called when any Menu Entry has been added. Please note, menu entries are added every frame / client tick! (roughly 20ms)

    MenuEntryAdded

    OnMenuOpened: 23

    Called when a menu has been opened

    MenuOpened

    OnMenuOptionClicked: 20

    Called when any Menu Entry has been clicked

    MenuOptionClicked

    OnPlayerDespawned: 9

    Called when a player has logged out / died or is no longer within render range

    PlayerDespawned

    OnPlayerSpawned: 8

    Called when a player has spawned or became visible within render range

    PlayerSpawned

    OnProjectileMoved: 7

    Called when a projectile has moved in the game, could be used for detecting when a projectile has spawned!

    ProjectileMoved

    OnShutdown: 2

    Called when the script shuts down, should be used to clean up any references

    OnStart: 0

    Called when the script starts, should be used to setup variables

    OnStatChanged: 24

    Called when the LocalPlayer's stat has changed

    StatChanged

    OnVarbitChanged: 28

    Called when an Varbit or VarPlayer has changed

    VarbitChanged

    OnWallObjectDespawned: 16

    Called when a Wall Object is removed or is no longer within render range

    WallObjectDespawned

    OnWallObjectSpawned: 15

    Called when a Wall Object is created or became visible within render distance

    WallObjectSpawned

    OnWidgetLoaded: 6

    Called when a widget was loaded such as your inventory or bank

    WidgetLoaded

    Settings

    Member Visibility

    On This Page

    Enumeration Members