OSRS Plugin API
    Preparing search index...

    Function highlightPlayerChannelActive

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

      Parameters

      • channelId: number

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

      • displayName: string

        The display name of the specified player.

      Returns boolean

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

      wasFound, playerId = osrs.ClientOp.pFindself();

      osrs.ClientOp.highlightPlayerOn(5, osrs.ClientOp.pName(playerId))

      -- Prints: true
      osrs.print(tostring(osrs.ClientOp.highlightPlayerChannelActive(5, osrs.ClientOp.pName(playerId))))

      osrs.ClientOp.highlightPlayerOff(5, osrs.ClientOp.pName(playerId))

      -- Prints: false
      osrs.print(tostring(osrs.ClientOp.highlightPlayerChannelActive(5, osrs.ClientOp.pName(playerId))))