OSRS Plugin API
    Preparing search index...

    Function highlightObjChannelActive

    • Finds if the specified object has been highlighted through the specified channel.

      Parameters

      • typeId: number

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

      • coord: number

        The coordinate of the specified object. Integer.

      • channelId: number

        The id of the specified highlight channel. Positive integer.

      • useSourceCoord: boolean

        Flag to use source coordinates instead of world coordinates.

      Returns boolean

      Whether the specified object has been highlighted through the specified channel. If specified channel does not exist this is also false.

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

      -- Prints: true
      osrs.print(tostring(osrs.ClientOp.highlightObjChannelActive(osrs.gamevals.objtypes.potEmpty, coord:toBitPacked(), 5, false)))

      osrs.ClientOp.highlightObjOff(osrs.gamevals.objtypes.potEmpty, coord:toBitPacked(), 5, false)

      -- Prints: false
      osrs.print(tostring(osrs.gamevals.objtypes.potEmpty, coord:toBitPacked(), 5, false)))