From WikiChip
Difference between revisions of "mirc/on events/on hotlink"
< mirc‎ | on events

(Created On hotlink event - mIRC)
 
m (→‎Parameters: Link access levels)
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
The '''ON HOTLINK''' event allows the targeting of certain words to create mouse hover, or double-clickable link events for.
+
{{mirc title|On Hotlink - Events}}
 +
The '''ON HOTLINK''' event triggers when you use your mouse over a specific word in a line of text in a window.
  
−
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.
+
The '''ON HOTLINK''' event is very intensive, in that it monitors and tracks all mouse movements.
−
 
+
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 level for the event to trigger.
+
<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 [[wildcard]].
+
<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.
 
<span style="display: inline-block; width: 105px;">'''<*#?=!@>'''</span>The window type that this event should monitor.
Line 30: Line 38:
  
 
== Examples ==
 
== Examples ==
−
Monitor all windows for both the text 'hoverme' and echo to the active window that the word was hovered:
+
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>
 
<source lang="mIRC">ON *:HOTLINK:*hoverme*:*:echo -a $1 was just hovered!</source>
  
−
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).
+
== Old on hotlink handling ==
  
−
The second event allows the double-click feature to return some information about the hotlink:
+
The event was revamped in mIRC 7.23, before, the event was working somewhat differently from others events:
−
<source lang="mIRC">ON ^*:HOTLINK:*hoverme*:*:{
+
 
−
  if ($1 == hoverme) return
+
<source lang="mIRC">
−
  halt
+
on ^*:HOTLINK:*help*:#:{
 +
if ($1 == helpme) return
 +
halt
 
}
 
}
−
ON *:HOTLINK:*hoverme*:*:echo -a Hotlink: $1 - Hotlink line: $hotline - Hotlink line Position: $hotlinepos</source>
 
  
−
Upon hovering over the word ''hoverme'' as shown in the above example, the following resembles the output:
+
on *:HOTLINK:*:*:echo clicked word $1 in line $hotline $hotlinepos
−
<pre>Hotlink: hoverme - Hotlink line: hoverme - Hotlink line Position: 1 269</pre>
+
</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 ==
 
== Compatibility ==
−
Added: mIRC v5.61
+
{{mIRC compatibility|5.61}}
  
−
Added On: 23/09/99
+
== See Also ==
 +
* {{mIRC|$hotline}}
 +
* {{mIRC|$hotlinepos}}
 +
* {{mIRC|$hotlink}}
 +
* {{mIRC|/hotlink}}
  
−
== See Also ==
+
{{mIRC on event list}}
−
* [[$hotline identifier - mIRC|$hotline]]
 
−
* [[$hotlinepos identifier - mIRC|$hotlinepos]]
 
  
−
[[Category:mIRC on events]]
+
[[Category:mIRC on events|hotlink]]

Latest revision as of 06:41, 6 February 2024

Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
v · d · e

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. 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.

Synopsis[edit]

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

You can use /return to enable hotlink over the current word and you can /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 $hotlink() to get the mouse event as well as informations about the line number, the word position etc..

Parameters[edit]

<level>The corresponding access levels for the event to trigger.

<matchtext>The text that to be matched. Can also be a wildcard.

<*#?=!@>The window type that this event should monitor.

*Any window
#Any channel, or specific channel name(s)
?Query windows
=DCC Chat windows
!Fserve windows
@Custom windows

<commands>The commands to be performed when the event listener's criteria is met.

Examples[edit]

Monitor all windows for the a word matchting '*hoverme*' and echo to the active window the word that was hovered: 

ON *:HOTLINK:*hoverme*:*:echo -a $1 was just hovered!

Old on hotlink handling[edit]

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

on ^*:HOTLINK:*help*:#:{
 if ($1 == helpme) return
 halt
}
 
on *:HOTLINK:*:*:echo clicked word $1 in line $hotline $hotlinepos
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, $hotline and $hotlinepos still work as they should with the new implementation but can be considered somewhat deprecated as the general $hotlink() now gathers all the precious informations.

Compatibility[edit]

Added: mIRC v5.61
Added on: 23 Sep 1999
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See Also[edit]


v · d · e mIRC on event list

A on Action, on Active, on Agent, on Appactive

B on Ban

C on Char, on Chat, on Chatclose, on Chatopen, on Close, on Connect, on Connectfail, on Ctcpreply

D on Dccserver, on Dehelp, on Deop, on Deowner, on Devoice, on Dialog, on Disconnect, on Dns

E on Error, on Exit

F on Filercvd, on Filesent

G on Getfail

H on Help, on Hotlink

I on Input, on Invite

J on Join

K on Keydown, on Keyup, on Kick

L on Load, on Logon

M on Midiend, on Mode, on Mp3end

N on Nick, on Nosound, on Notice, on Notify

O on Op, on Open, on Owner

P on Parseline, on Part, on Ping, on Playend, on Pong

Q on Queryclose, on Queryopen, on Quit

R on Rawmode

S on Sendfail, on Serv, on Servclose, on Servermode, on Serverop, on Servopen, on Signal, on Snotice,  on Sockclose, on Socklisten, on Sockopen, on Sockread, on Sockwrite, on Start

T on Text, on Topic

U on Udpread, on Udpwrite, on Unban, on Unload, on Unotify, on Usermode

V on Vcmd, on Voice

W on Wallops, on Waveend

Retrieved from "https://en.wikichip.org/w/index.php?title=mirc/on_events/on_hotlink&oldid=102228"