OSRS Plugin API
    Preparing search index...

    Function highlightNpcChannelsGetActive

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

      Parameters

      • npcId: number

        The id of the specified npc. Integer.

      • npcCreationCycle: number

        Server cycle that the specified NPC was created on - obtained by ClientOp.npcCreationCycle. Integer.

      Returns HighlightConfig[]

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

      id = osrs.ClientOp.getNpcIdByName("Brugsen Bursen")
      osrs.ClientOp.highlightNpcOn(id, osrs.ClientOp.npcCreationCycle(id), 3)

      local highlights = osrs.ClientOp.highlightNpcChannelsGetActive(id, osrs.ClientOp.npcCreationCycle(id))

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