OSRS Plugin API
    Preparing search index...

    Function highlightObjOn

    • Turns on the highlight on the specified object. Disable through ClientOp.highlightObjOff If the object has already been highlighted with other channel ids, the channel with the smallest id that is also enabled will be the channel through which the highlight gets its properties from.

      Parameters

      • typeId: number

        ID of the object type to highlight. Integer.

      • coord: number

        The coordinate of the object in bitpacked form. Integer.

      • channelId: number

        The highlight channel [1-32]. If specified channel is not enabled the highlight will not be visible. Positive Integer.

      • useSourceCoord: boolean

        Flag to use source coordinates instead of world coordinates.

      Returns void

      -- Highlights the Pot in Lumbridge castle's kitchen.
      coord = osrs.MapCoord.new(0, (50 * 64) + 9, (50 * 64) + 14)
      osrs.ClientOp.highlightObjOn(osrs.gamevals.objtypes.pot_empty, coord:toBitPacked(), 5, false)