OSRS Plugin API
    Preparing search index...

    Function highlightCategoryEnabledConfigGet

    • Combs through a given category of channels and returns the configuration of all channels that are enabled through isEnabled in HighlightConfig paired with the channel id the config was in. Will print out an error if the category id does not line up with an actual category.

      Parameters

      • categoryId: number

        The id of the category to comb through. Check ClientOp.HighlightCategory for which id's line up with which categories.

      Returns HighlightConfig[]

      A map of channel ids and corresponding ClientOp.HighlightConfig. Only channel id's and configs that are enabled are included. Valid channels go from 0-32.

      npcHighlights = osrs.ClientOp.highlightCategoryEnabledConfigGet(osrs.ClientOp.HighlightCategory.NPC)

      -- Prints out the id and properties of all enabled NPC highlight channels
      for id, highlight in pairs(npcHighlights) do
      osrs.print("Channel ID: " .. tostring(id))
      osrs.print("Channel Properties: " .. tostring(highlight))
      end