Project

General

Profile

Scripting Events » History » Revision 30

Revision 29 (Per Amundsen, 11/13/2015 05:34 AM) → Revision 30/120 (Per Amundsen, 11/13/2015 05:45 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]] 
 [[on CTCP]] 
 [[on ACTION]] 
 [[on ACTIVE]] 
 [[on APPACTIVE]] 
 [[on BAN]] 
 [[on CHAT]] 
 [[on CLIENTTEXT]] 
 [[on CLOSE]] 
 [[on CONNECT]] 
 [[on CONNECTFAIL]] 
 [[on CTCPREPLY]] 
 [[on DEHELP]] 
 [[on DEOP]] 
 [[on DEVOICE]] 
  |^. [[on DIALOG]] 
 [[on DISCONNECT]] 
 [[on DNS]] 
 
  |^. [[on DNS]] 
 [[on ERROR]] 
 [[on EXIT]] 
 [[on FILERCVD]] 
 [[on FILESENT]] 
 [[on GETFAIL]] 
 [[on HELP]] 
 [[on HOTLINK]] 
 [[on INPUT]] 
 [[on INVITE]] 
 [[on JOIN]] 
 [[on KEYDOWN]] 
   |^. [[on KEYUP]] 
 [[on KICK]] 
 [[on LOAD]] 
 [[on LOGON]] 
 [[on MODE]] 
 [[on MP3END]] 
 [[on NICK]] 
 
   |^. [[on NOTICE]] 
 [[on NOTIFY]] 
 [[on OP]] 
 [[on OPEN]] OPEN|CLOSE]] 
 [[on OPTIONS]] 
 [[on PARSELINE]] 
 [[on PART]] 
 [[on PING]] 
  |^.    
 [[on PONG]] 
 [[on QUIT]] 
 [[on RAWMODE]] 
 [[on RESUME]] 
 [[on SENDFAIL]] 
 [[on SERVERMODE]] 
 [[on SIGNAL]] 
 [[on SNOTICE]] 
 [[on SOCKCLOSE]] 
 
  |^.    [[on SOCKLISTEN]] 
 [[on SOCKOPEN]] 
 [[on SOCKREAD]] 
 [[on SONG]] 
 [[on START]] 
 [[on SUSPEND]] 
  |^.    
 [[on TABCOMP]] 
 [[on TEXT]] 
 [[on TOPIC]] 
 [[on UNBAN]] 
 [[on UNLOAD]] 
 [[on UNNOTIFY]] 
 [[on UNOTIFY]] 
 [[on USERMODE]] 
 [[on VOICE]] 
 [[on WALLOPS]] 
 [[on 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>