From WikiChip
Editing mirc/on events/on hotlink

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 1: Line 1:
−
{{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.
−
The '''ON HOTLINK''' event triggers when you use your mouse over a specific word in a line of text in a window.
 
  
−
The '''ON HOTLINK''' event is very intensive, in that it monitors and tracks all mouse movements.
+
This event fills the [[$hotline identifier - mIRC|$hotline]] and [[$hotlinepos identifier - 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.
−
Therefore any commands executed in the event must be as quick, efficient, and small as possible. If the commands take too long to proceede, mIRC will begin to lag a great deal.
+
 
 +
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 ==
 
== Synopsis ==
 
<pre>ON <level>:HOTLINK:<matchtext>:<*#?=!@>:<commands></pre>
 
<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 ==
 
== 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;">'''<level>'''</span>The level 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;">'''<matchtext>'''</span>The text that to be matched. Can also be a [[wildcard]].
  
 
<span style="display: inline-block; width: 105px;">'''<*#?=!@>'''</span>The window type that this event should monitor.
 
<span style="display: inline-block; width: 105px;">'''<*#?=!@>'''</span>The window type that this event should monitor.
Line 38: Line 30:
  
 
== Examples ==
 
== Examples ==
−
Monitor all windows for the a word matchting '*hoverme*' and echo to the active window the word that was hovered:
+
Monitor all windows for both the text 'hoverme' and echo to the active window that the word was hovered:
 
<source lang="mIRC">ON *:HOTLINK:*hoverme*:*:echo -a $1 was just hovered!</source>
 
<source lang="mIRC">ON *:HOTLINK:*hoverme*:*:echo -a $1 was just hovered!</source>
  
−
== Old on hotlink handling ==
+
The next example has 2 events. One contains an '''^''' prefix, which signifies elevation. This event will stop all hotlinks if the criteria set is not met. However, if criteria is met, and a match is made, the hotlink will become clickable (this is apparent when the mouse cursor becomes the hand-pointer).
  
−
The event was revamped in mIRC 7.23, before, the event was working somewhat differently from others events:
+
The second event allows the double-click feature to return some information about the hotlink:
−
 
+
<source lang="mIRC">ON ^*:HOTLINK:*hoverme*:*:{
−
<source lang="mIRC">
+
  if ($1 == hoverme) return
−
on ^*:HOTLINK:*help*:#:{
+
  halt
−
if ($1 == helpme) return
 
−
halt
 
 
}
 
}
 +
ON *:HOTLINK:*hoverme*:*:echo -a Hotlink: $1 - Hotlink line: $hotline - Hotlink line Position: $hotlinepos</source>
  
−
on *:HOTLINK:*:*:echo clicked word $1 in line $hotline $hotlinepos
+
Upon hovering over the word ''hoverme'' as shown in the above example, the following resembles the output:
−
</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.
+
<pre>Hotlink: hoverme - Hotlink line: hoverme - Hotlink line Position: 1 269</pre>
  
−
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 ==
 +
Added: mIRC v5.61
  
−
== Compatibility ==
+
Added On: 23/09/99
−
{{mIRC compatibility|5.61}}
 
  
 
== See Also ==
 
== See Also ==
−
* {{mIRC|$hotline}}
+
* [[$hotline identifier - mIRC|$hotline]]
−
* {{mIRC|$hotlinepos}}
+
* [[$hotlinepos identifier - mIRC|$hotlinepos]]
−
* {{mIRC|$hotlink}}
 
−
* {{mIRC|/hotlink}}
 
−
 
 
−
{{mIRC on event list}}
 
  
−
[[Category:mIRC on events|hotlink]]
+
[[Category:mIRC on events]]

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://en.wikichip.org/wiki/mirc/on_events/on_hotlink"