OSRS Plugin API
    Preparing search index...

    Function highlightObjChannelsGetActive

    • Will return all channels in which the specified object have been highlighted through.

      Parameters

      • typeId: number

        The id of the object type of the specified object. Integer

      • coord: number

        The coordinate of the specified object. Integer.

      • useSourceCoord: boolean

        Flag to use source coordinates instead of world coordinates.

      Returns HighlightConfig[]

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

      local coord = osrs.MapCoord.new(0, (50 * 64) + 9, (50 * 64) + 14)
      osrs.ClientOp.highlightObjOn(osrs.gamevals.objtypes.potEmpty, coord:toBitPacked(), 3, false)

      local highlights = osrs.ClientOp.highlightObjChannelsGetActive(osrs.gamevals.objtypes.potEmpty, coord:toBitPacked(), false)
      -- Now prints out the channels that highlights of a empty pot object at the specified coordinate pass through
      -- What this should prints out should include channel Id 3 along with the properties at object highlight channel 3
      for id, highlightProperties in pairs(highlights) do
      osrs.print("Channel ID: " .. tostring(id))
      osrs.print("Channel Properties: " .. tostring(highlightProperties))
      end