OSRS Plugin API
    Preparing search index...

    Function highlightTileChannelsGetActive

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

      Parameters

      • coord: number

        The coordinate of the specified tile in a bitpacked form. 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 tile category. A channel will appear on the map if a highlight on the specified tile is done through that channel. Valid channels go from 0-32.

      osrs.ClientOp.highlightTileOn(osrs.ClientOp.coord(false):toBitPacked(), 3, true)

      local highlights = osrs.ClientOp.highlightTileChannelsGetActive(osrs.ClientOp.coord(false):toBitPacked(), true)

      -- Now prints out the channels that highlights of the tile directly under the client's player pass through
      -- What this should prints out should include channel Id 3 along with the properties at tile highlight channel 3
      for id, highlightProperties in pairs(highlights) do
      osrs.print("Channel ID: " .. tostring(id))
      osrs.print("Channel Properties: " .. tostring(highlightProperties))
      end