OSRS Plugin API
    Preparing search index...

    Function highlightPlayerChannelsGetActive

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

      Parameters

      • displayName: string

        The display name of the specified player.

      Returns HighlightConfig[]

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

      wasFound, playerId = osrs.ClientOp.pFindself();
      osrs.ClientOp.highlightPlayerOn(3, osrs.ClientOp.pName(playerId))

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