OSRS Plugin API
    Preparing search index...

    Function highlightObjTypeOff

    • Disables the highlighting of the object type. *

      Parameters

      • typeId: number

        ID of the object type to highlight. Integer.

      • channelId: number

        The highlight channel [1-32]. Positive Integer.

      Returns void

      --Disables highlighting of eggs
      osrs.ClientOp.highlightObjTypeOff(osrs.gamevals.objtypes.egg, 9)
    • Will return all channels in which the specified object type have been highlighted through.

      Parameters

      • typeId: number

        id of the specified object type. Integer.

      Returns HighlightConfig[]

      A map of channel ids and corresponding ClientOp.HighlightConfig within the objtype category. A channel will appear on the map if a highlight on the specified objtype is done through that channel. Valid channels go from 0-32.

      osrs.ClientOp.highlightObjTypeOn(osrs.gamevals.objtypes.egg, 3)

      local highlights = osrs.ClientOp.highlightObjTypeChannelsGetActive(osrs.gamevals.objtypes.egg)
      -- Now prints out the channels that highlights of the egg objtype pass through
      -- What this should prints out should include channel Id 3 along with the properties at objtype highlight channel 3
      for id, highlightProperties in pairs(highlights) do
      osrs.print("Channel ID: " .. tostring(id))
      osrs.print("Channel Properties: " .. tostring(highlightProperties))
      end