Editing mirc/on events/on hotlink

{{mirc title|On Hotlink - Events}}
The '''ON HOTLINK''' event allows the targeting of certain words to create mouse hover, or double-clickable link events for.

This event fills the {{mIRC|$hotline}} and {{mIRC|$hotlinepos}} identifiers with both the entire ''line of text'', and the ''position in the text'' the link appears, respectively. The '''$1''' identifier is also filled with the hotlink matchtext that triggered the event in the first place.

The '''ON HOTLINK''' event is very intensive, in that it monitors and tracks all mouse movements, and therefore any commands which the event triggers must be as quick, efficient, and small as possible. The reason behind this command minimalistic nature is simply because the event runs every time, and therefore tries to keep up in real-time. If the commands are too large, or process-intense, mIRC will begin to lag a great deal.

== Synopsis ==
<pre>ON <level>:HOTLINK:<matchtext>:<*#?=!@>:<commands></pre>

You can use {{mirc|/return}} to enable hotlink over the current word and you can {{mIRC|/halt}} to disable hotlink and allows default processing.

$1 returns the word that matched, stripped from its control code.

'''Note''': $hotlink() can be used to get the word that matched with control codes preserved.

The event triggers for various mouse events: sclick, dclick, rclick, mouse, uclick, you can use {{mIRC|$hotlink|$hotlink()}} to get the mouse event as well as informations about the line number, the word position etc..

== Parameters ==
<span style="display: inline-block; width: 105px;">'''<level>'''</span>The corresponding {{mIRC|access levels}} for the event to trigger.

<span style="display: inline-block; width: 105px;">'''<matchtext>'''</span>The text that to be matched. Can also be a {{mirc|wildcard}}.

<span style="display: inline-block; width: 105px;">'''<*#?=!@>'''</span>The window type that this event should monitor.

<div style="background-color: rgba(0,0,0,.03); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''*'''</span>Any window</div>

<div style="background-color: rgba(0,0,0,.06); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''#'''</span>Any channel, or specific channel name(s)</div>

<div style="background-color: rgba(0,0,0,.03); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''?'''</span>Query windows</div>

<div style="background-color: rgba(0,0,0,.06); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''='''</span>DCC Chat windows</div>

<div style="background-color: rgba(0,0,0,.03); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''!'''</span>Fserve windows</div>

<div style="background-color: rgba(0,0,0,.06); display: block;"><span style="border-right: 1px dashed rgba(0,0,0,.15); display: inline-block; margin-left: 105px; margin-right: 25px; width: 60px;">'''@'''</span>Custom windows</div>

<span style="display: inline-block; width: 105px;">'''<commands>'''</span>The commands to be performed when the event listener's criteria is met.

== Examples ==
Monitor all windows for the a word matchting '*hoverme*' and echo to the active window the word that was hovered:
<source lang="mIRC">ON *:HOTLINK:*hoverme*:*:echo -a $1 was just hovered!</source>

== Old on hotlink handling ==

The event was revamped in mIRC 7.23, before, the event was working somewhat differently from others events:

<source lang="mIRC">
on ^*:HOTLINK:*help*:#:{
 if ($1 == helpme) return
 halt
}

on *:HOTLINK:*:*:echo clicked word $1 in line $hotline $hotlinepos
</source>The first ^ event is triggered when you move your mouse over a word that matches *help* in a channel window. You can then check $1 to see if you want the hotlink hand to appear over the word. If you halt the event, no hand will appear. The second non-^ event is triggered when you double-click on a word which has been filtered through the first hotlink event.

This implementation was very limited and is deprecated, {{mirc|$hotline}} and {{mirc|$hotlinepos}} still work as they should with the new implementation but can be considered somewhat deprecated as the general {{mirc|$hotlink|$hotlink()}} now gathers all the precious informations.

== Compatibility ==
{{mIRC compatibility|5.61}}

== See Also ==
* {{mIRC|$hotline}}
* {{mIRC|$hotlinepos}}
* {{mIRC|$hotlink}}
* {{mIRC|/hotlink}}

{{mIRC on event list}}

[[Category:mIRC on events|hotlink]]