Project

General

Profile

Scripting Events » History » Revision 28

Revision 27 (Per Amundsen, 11/13/2015 05:29 AM) → Revision 28/120 (Per Amundsen, 11/13/2015 05:31 AM)

{{>toc}} 

 h1. Scripting Event Options 

 Supported <level> prefixes: 

 & - Ignore the event if another event has already halted the text. 
 ^ - Enable halt events (hide default text output from the event) 
 ! - Ignore events made by you 
 @ - Only trigger if you have channel op 
 $ - Indicate the wildcard text is a regular expression. 
 me: - Ignore events not made by you. 
 [+]<level> - Level to match. 

 h1. Scripting Event Evaluation 

 Matchtext and Target Window can be evaluated using $(code) or contain a single %variable. 

 *Example* 
 <pre> 
 ; Set a target variable. 
 set %target #channel 

 ; Subscribe to the TEXT event, try evaluate my nick, and if it matches, print a text. 
 on *:TEXT:$(* $+ $me $+ *)):%target:echo -ag My nick was highlighted on %target 
 </pre> 

 h1. Scripting Events 

 |^. [[on RAW]] [[RAW]] 
 [[on CTCP]] [[CTCP]] 
 on [[on ACTION]] [[ACTION]] 
 on [[on ACTIVE]] [[ACTIVE]] 
 on [[on APPACTIVE]] [[APPACTIVE]] 
 on [[on BAN]] [[BAN]] 
 on [[on CHAT]] [[CHAT]] 
 on [[on CLIENTTEXT]] [[CLIENTTEXT]] 
 on [[on CONNECT]] [[CONNECT]] 
 on [[on CONNECTFAIL]] [[CONNECTFAIL]] 
 on [[on CTCPREPLY]] [[CTCPREPLY]] 
 on [[on DEHELP]] [[DEHELP]] 
 on [[on DEOP]] [[DEOP]] 
 on [[on DEVOICE]] [[DEVOICE]] 
 on [[on DISCONNECT]] [[DISCONNECT]] 
 on [[on DNS]] [[DNS]] 
  |^. on [[on ERROR]] [[DNS]] 
 on [[on EXIT]] [[ERROR]] 
 on [[on FILERCVD]] [[EXIT]] 
 on [[on FILESENT]] [[FILERCVD]] 
 on [[on GETFAIL]] [[FILESENT]] 
 on [[on HELP]] [[GETFAIL]] 
 on [[on HOTLINK]] [[HELP]] 
 on [[on INPUT]] [[HOTLINK]] 
 on [[on INVITE]] [[INPUT]] 
 on [[on JOIN]] [[INVITE]] 
 on [[on KICK]] [[JOIN]] 
 on [[on LOAD]] [[KICK]] 
 on [[on LOGON]] [[LOAD]] 
 on [[on MODE]] [[LOGON]] 
 on [[on MP3END]] [[MODE]] 
 on [[MP3END]] 
  |^. on [[on NICK]] [[NICK]] 
 on [[on NOTICE]] [[NOTICE]] 
 on [[on NOTIFY]] [[NOTIFY]] 
 on [[on OP]] [[OP]] 
 on [[on OPEN|CLOSE]] [[OPEN|CLOSE]] 
 on [[on OPTIONS]] [[OPTIONS]] 
 on [[on PARSELINE]] [[PARSELINE]] 
 on [[on PART]] [[PART]] 
 on [[on PING]] [[PING]] 
 on [[on PONG]] [[PONG]] 
 on [[on QUIT]] [[QUIT]] 
 on [[on RAWMODE]] [[RAWMODE]] 
 on [[on RESUME]] [[RESUME]] 
 on [[on SENDFAIL]] [[SENDFAIL]] 
 on [[on SIGNAL]] [[SIGNAL]] 
 on [[on SNOTICE]] [[SNOTICE]] 
  |^. on [[on SOCKCLOSE]] [[SOCKCLOSE]] 
 on [[on SOCKLISTEN]] [[SOCKLISTEN]] 
 on [[on SOCKOPEN]] [[SOCKOPEN]] 
 on [[on SOCKREAD]] [[SOCKREAD]] 
 on [[on SONG]] [[SONG]] 
 on [[on START]] [[START]] 
 on [[on SUSPEND]] [[SUSPEND]] 
 on [[on TABCOMP]] [[TABCOMP]] 
 on [[on TEXT]] [[TEXT]] 
 on [[on TOPIC]] [[TOPIC]] 
 on [[on UNBAN]] [[UNBAN]] 
 on [[on UNLOAD]] [[UNLOAD]] 
 on [[on UNNOTIFY]] [[UNNOTIFY]] 
 on [[on USERMODE]] [[USERMODE]] 
 on [[on VOICE]] [[VOICE]] 
 on [[on WALLOPS]] [[WALLOPS]] 
  | 

 <pre> 
 raw <numeric>:<matchtext>:<commands> 

 ctcp <level>:<matchtext>:<*|#|?>:<commands> 

 on <level>:SOCKOPEN:name:commands 

 on <level>:SOCKREAD:name:commands 

 on <level>:SOCKLISTEN:name:commands 

 on <level>:SOCKCLOSE:name:commands 

 on <level>:SIGNAL:name:command 

 on <level>:LOGON:*:<commands> 

 on <level>:DNS:<commands> 

 on <level>:CTCPREPLY:<matchtext>:<commands> 

 on <level>:OPEN|CLOSE:<?|@|=|!|*>:<matchtext>:<commands> 

 on <level>:APPACTIVE:<commands> 

 on <level>:ACTIVE:<*#?=!@>:<commands> 

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

 on <level>:INVITE:<#[,#]>:<commands> 

 on <level>:TABCOMP:<*#?=!@>:<commands> 

 on <level>:WALLOPS:<matchtext>:<commands> 

 on <level>:ERROR:<matchtext>:<commands> 

 on <level>:RAWMODE:#:<commands> 

 on <level>:DEHELP:<#[,#]>:<commands> 

 on <level>:HELP:<#[,#]>:<commands> 

 on <level>:DEVOICE:<#[,#]>:<commands> 

 on <level>:VOICE:<#[,#]>:<commands> 

 on <level>:DEOP:<#[,#]>:<commands> 

 on <level>:OP:<#[,#]>:<commands> 

 on <level>:INPUT:<*#?=!@>:<commands> 

 on <level>:UNBAN:<#[,#]>:<commands> 

 on <level>:BAN:<#[,#]>:<commands> 

 on <level>:CHAT:<matchtext>:<commands> 

 on <level>:KICK:<#[,#]>:<commands> 

 on <level>:NOTIFY:<commands> 

 on <level>:UNNOTIFY:<commands> 

 on <level>:NICK:<commands> 

 on <level>:QUIT:<commands> 

 on <level>:LOAD:<commands> 

 on <level>:UNLOAD:<commands>' 

 on <level>:START:<commands> 

 on <level>:EXIT:<commands> 

 on <level>:DNS:<commands> 

 on <level>:CONNECTFAIL:<commands> 

 on <level>:CONNECT:<commands> 

 on <level>:DISCONNECT:<commands> 

 on <level>:TOPIC:<#[,#]>:<commands> 

 on <level>:USERMODE:<commands> 

 on <level>:MODE:<#[,#]>:<commands> 

 on <level>:PART:<#[,#]>:<commands> 

 on <level>:JOIN:<#[,#]>:<commands> 

 on <level>:SNOTICE:<matchtext>:<commands> 

 on <level>:NOTICE:<matchtext>:<*><?><#[,#]>:<commands> 

 on <level>:ACTION:<matchtext>:<*><?><#[,#]>:<commands> 

 on <level>:TEXT:<matchtext>:<*><?><#[,#]>:<commands> 

 on <level>:MP3END:<commands> 

 on <level>:PARSELINE:<in|out|*>:matchtext:<commands> 

 on <level>:PING:<commands> 

 on <level>:PONG:<commands> 

 on <level>:FILESENT:<filename[,filename]>:<commands> 

 on <level>:FILERCVD:<filename[,filename]>:<commands> 

 on <level>:SENDFAIL:<filename[,filename]>:<commands> 

 on <level>:GETFAIL:<filename[,filename]>:<commands> 

 Triggers when the computer is about to suspend. 
 on <level>:SUSPEND:<commands> 

 Triggers when the computer resumes from suspend. 
 on <level>:RESUME:<commands> 

 Triggers when the chosen media player changes song. 
 on <level>:SONG:<commands> 

 Triggers whenever the config file is reloaded 
 on <level>:OPTIONS:<commands> 

 Triggers whenever the client sends a client text to any window, $1- will hold the original client text, haltable. 
 on <level>:CLIENTTEXT:<matchtext>:<*#?=!@>:<commands> 
 </pre>