OSRS Plugin API
    Preparing search index...

    Function highlightNpcChannelActive

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

      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.

      • highlightChannel: number

        The id of the specified highlight channel [1-32]. Positive Integer.

      Returns boolean

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

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

      -- Prints: true
      osrs.print(tostring(osrs.ClientOp.highlightNpcChannelActive(id, osrs.ClientOp.npcCreationCycle(id), 6)))

      osrs.ClientOp.highlightNpcOff(id, osrs.ClientOp.npcCreationCycle(id), 6)

      -- Prints: false
      osrs.print(tostring(osrs.ClientOp.highlightNpcChannelActive(id, osrs.ClientOp.npcCreationCycle(id), 6)))