OSRS Plugin API
    Preparing search index...

    Namespace ClientOp

    This section contains functions that allow you to interact and change things currently occurring in the client. Functions in this section will allow your plugin script to get information from the client, such as finding the exact name of an NPC (npcName), and also allow you to give the client command instructions, such as making a specific NPC say a specific phrase (npcSay).

    Lets say you wanted to create a plugin that would highlight all goblin NPC’s. You can use ClientOp functions to find all the local NPC’s with the “goblin” id (getNpcIdByNameAll) and use those ids to highlight all of the NPC’s that match that npc type (highlightNpcOn).

    Now let's say you want to make a plugin that will make all NPC’s randomly say funny jokes. To do so you would use the function to select all NPCs (getNpcIdAll) and the function to make NPCs speak (npcSay). The first function will allow you to get information about all of the NPC’s currently rendered on screen, and the second function allows you to make an NPC say a message in the game.

    This section not only allows you to highlight and find NPC’s, it also allows you to get information on the current player, the current players inventory, objects, and locations. By applying all of these functions you can create plugins that interact with the players and their current OSRS world.

    Enumerations

    HighlightCategory
    WornSlots

    Classes

    HighlightConfig

    Functions

    areProjectilesRendered
    coord
    coordFine
    friendsChatGetChatCount
    friendsChatGetDisplayName
    getNpcIdAll
    getNpcIdByName
    getNpcIdByNameAll
    getNpcObj
    getPlayerIdAll
    getPlayerIdByName
    getPlayerObj
    highlightCategoryEnabledConfigGet
    highlightChannelConfigGet
    highlightChannelConfigure
    highlightNpcChannelActive
    highlightNpcChannelsGetActive
    highlightNpcOff
    highlightNpcOn
    highlightNpcTypeChannelActive
    highlightNpcTypeChannelsGetActive
    highlightNpcTypeOff
    highlightNpcTypeOn
    highlightObjChannelActive
    highlightObjChannelsGetActive
    highlightObjOff
    highlightObjOn
    highlightObjTypeChannelActive
    highlightObjTypeOff
    highlightObjTypeOn
    highlightPlayerChannelActive
    highlightPlayerChannelsGetActive
    highlightPlayerOff
    highlightPlayerOn
    highlightTileChannelActive
    highlightTileChannelsGetActive
    highlightTileOff
    highlightTileOn
    invGetNum
    invGetObjId
    invSize
    invTotal
    locCoord
    locFind
    locGetOp
    locLength
    locName
    locTypeId
    locWidth
    npcCoord
    npcCoordFine
    npcCreationCycle
    npcName
    npcSay
    npcTypeId
    npcUid
    objCoord
    objCount
    objFind
    objGetOp
    objName
    objTypeId
    ocCost
    ocName
    ocOp
    ocStackable
    playerCoord
    playerFindSelf
    playerFineCoord
    playerName
    playerRouteLength
    playerSay
    renderProjectiles