OSRS Plugin API
    Preparing search index...

    Function highlightChannelConfigGet

    • This gets the configuration settings from the specified channel. This means it gets the properties applied to the highlights that pass through the specified channel. Please note that a colour gotten from a channel might be a bit different than the colour it was configured with, which happens due to conversions made to make the colour work with highlight configurment parameters. Will print an error if categoryId or channelId is out of range/invalid.

      Parameters

      • categoryId: number

        The id of a specified category of channel's to search in. Check ClientOp.HighlightCategory for which id's line up with which categories.

      • channelId: number

        The id of the channel within the specified category. Valid channels go from 0-32.

      Returns any

      The configuration settings currently applied to the given channel.

      local config = osrs.ClientOp.HighlightConfig.new()

      config.outlineWidth = 3
      config.enableTileOutline = true

      osrs.ClientOp.highlightChannelConfigure(osrs.ClientOp.HighlightCategory.NPC,30,config)

      -- Gotten config should be equal to config in every way but colour
      local configNpc = osrs.ClientOp.highlightChannelConfigGet(osrs.ClientOp.HighlightCategory.NPC,30)