Project

General

Profile

Scripting Commands » History » Revision 196

Revision 195 (Per Amundsen, 03/26/2020 09:48 AM) → Revision 196/211 (Per Amundsen, 03/26/2020 09:48 AM)

{{css 
 body { 
   counter-reset: count; 
 } 
 .tcount { 
   counter-reset: adi; 
 } 
 .tcount a { 
   counter-increment: count; 
 } 
 .tcount strong { 
   counter-increment: adi; 
 } 
 .acounter::before { 
   content: "Total: " counter(count) " commands, " counter(adi) " are AdiIRC exclusive. "; 
 } 
 }} 

 {{>toc}} 

 h1. Scripting Commands 

 Parameters in [x] means they are optional. 
 Parameters in <x> means they are required. 
 Parameters with a x|y means either x or y can be used. 

 Click on a command to read more about it. 

 _Commands in bold is AdiIRC only._ 

 table(tcount). 
 |[[/abook]] 
 *[[/aclear]]* 
 [[/action]] 
 *[[/advertise]]* 
 [[/ajinvite]] 
 [[/alias]] 
 [[/aline]] 
 [[/amark]] 
 [[/ame]] 
 [[/amsg]] 
 *[[/allnick]]* 
 [[/anick]] 
 [[/aop]] 
 [[/auser]] 
 *[[/autoconnect]]* 
 [[/autojoin]] 
 [[/avoice]] 
 *[[/aquit]]* 
 [[/away]] 
 *[[/back]]* 
 [[/background]] 
 [[/ban]] 
 *[[/banlist]]* 
 [[/bcopy]] 
 [[/beep]] 
 *[[/betaup]]* 
 *[[/bin2txt]]* 
 [[/bindip]] 
 [[/bread]] 
 [[/break]] 
 [[/breplace]] 
 [[/bset]] 
 [[/btrunc]] 
 [[/bunset]] 
 *[[/bw]]* 
 [[/bwrite]] 
 [[/channel]] 
 *[[/channels]]* 
 *[[/charset]]* 
 [[/clear]] 
 [[/clearall]] 
 [[/cline]] 
 [[/clipboard]] 
 [[/close]] 
 [[/cnick]] 
  | [[/color]] 
 [[/colour]] 
 [[/comclose]] 
 [[/comlist]] 
 [[/comopen]] 
 [[/comreg]] 
 *[[/config]]* 
 [[/continue]] 
 [[/copy]] 
 [[/creq]] 
 [[/ctcp]] 
 [[/ctcps]] 
 [[/ctcpreply]] 
 *[[/cycleall]]* 
 [[/dcc]] 
 [[/dde]] 
 [[/ddeserver]] 
 [[/debug]] 
 [[/dec]] 
 *[[/dehalfop]]* 
 *[[/deop]]* 
 [[/describe]] 
 *[[/desop]]* 
 *[[/devoice]]* 
 [[/dialog]] 
 [[/did]] 
 [[/didtok]] 
 [[/disable]] 
 [[/disconnect]] 
 [[/dlevel]] 
 [[/dline]] 
 [[/dll]] 
 [[/dns]] 
 *[[/dock]]* 
 *[[/dockpanels]]* 
 *[[/download]]* 
 [[/drawcopy]] 
 [[/drawdot]] 
 [[/drawfill]] 
 [[/drawline]] 
 [[/drawpic]] 
 [[/drawrect]] 
 [[/drawreplace]] 
 [[/drawrot]] 
 [[/drawsave]] 
  | [[/drawscroll]] 
 [[/drawsize]] 
 [[/drawtext]] 
 [[/ebeeps]] 
 [[/echo]] 
 *[[/echomonitor]]* 
 *[[/echox]]* 
 *[[/edit]]* 
 [[/editbox]] 
 [[/else]] 
 [[/elseif]] 
 [[/emailaddr]] 
 [[/enable]] 
 *[[/encoding]]* 
 [[/events]] 
 [[/exit]] 
 *[[/fakeraw]]* 
 [[/fclose]] 
 *[[/fget]]* 
 [[/filter]] 
 [[/findtext]] 
 [[/firewall]] 
 [[/flash]] 
 [[/flist]] 
 [[/flushini]] 
 [[/font]] 
 [[/fopen]] 
 [[/fseek]] 
 [[/fsend]] 
 [[/fullname]] 
 *[[/fullscreen]]* 
 [[/fupdate]] 
 [[/fwrite]] 
 *[[/gcmem]]* 
 *[[/globalkeys]]* 
 *[[/google]]* 
 [[/goto]] 
 [[/groups]] 
 [[/guser]] 
 [[/hadd]] 
 *[[/halfop]]* 
 [[/halt]] 
 [[/haltdef]] 
 [[/hdec]] 
 [[/hdel]] 
  | [[/help]] 
 [[/hfree]] 
 *[[/highlight]]* 
 [[/hinc]] 
 [[/hload]] 
 [[/hmake]] 
 [[/hop]] 
 [[/hotlink]] 
 *[[/hrename]]* *[[/hrename]* 
 [[/hsave]] 
 [[/ial]] 
 [[/ialfill]] 
 [[/ialmark]] 
 [[/identd]] 
 *[[/icon]]* 
 [[/if]] 
 [[/ignore]] 
 [[/iline]] 
 [[/inc]] 
 *[[/inick]]* 
 *[[/inlineimage]]* 
 [[/invite]] 
 [[/iuser]] 
 [[/join]] 
 *[[/kblayout]]* 
 [[/kick]] 
 [[/kill]] 
 *[[/lag]]* 
 [[/leave]] 
 *[[/linemarker]]* 
 [[/linesep]] 
 [[/list]] 
 [[/load]] 
 [[/loadbuf]] 
 *[[/lock]]* 
 [[/log]] 
 *[[/logs]]* 
 [[/logview]] 
 [[/markall]] 
 [[/mdi]] 
 [[/me]] 
 [[/menubar]] 
 [[/mkdir]] 
 [[/mnick]] 
 [[/mode]] 
  | [[/msg]] 
 *[[/msgbox]]* 
 *[[/mute]]* 
 *[[/nextunread]]* 
 [[/nick]] 
 *[[/nickcolumn]]* 
 *[[/nicklist]]* 
 *[[/nmsg]]* 
 [[/noop]] 
 [[/notice]] 
 [[/notify]] 
 *[[/np]]* 
 *[[/oline]]* 
 [[/omsg]] 
 [[/onotice]] 
 [[/op]] 
 *[[/options]]* 
 [[/parseline]] 
 [[/part]] 
 [[/partall]] 
 *[[/paths]]* 
 *[[/pause]]* 
 [[/perform]] 
 *[[/pgoogle]]* 
 *[[/plugins]]* 
 [[/play]] 
 [[/playctrl]] 
 *[[/priv]]* 
 [[/protect]] 
 [[/proxy]] 
 [[/query]] 
 [[/queryrn]] 
 *[[/quickconnect]]* 
 *[[/quicksave]]* 
 [[/quit]] 
 [[/quote]] 
 [[/raw]] 
 *[[/rawx]]* 
 *[[/rawlog]]* 
 *[[/realname]]* 
 *[[/reconnect]]* 
 *[[/refreshsong]]* 
 *[[/rejoin]]* 
 [[/reload]] 
 [[/remini]] 
  |^. [[/remote]] 
 [[/remove]] 
 [[/rename]] 
 [[/renwin]] 
 [[/reseterror]] 
 [[/resetidle]] 
 *[[/resolve]]* 
 *[[/restart]]* 
 [[/return]] 
 [[/returnex]] 
 [[/rlevel]] 
 [[/rline]] 
 [[/rmdir]] 
 [[/run]] 
 [[/ruser]] 
 [[/say]] 
 [[/savebuf]] 
 [[/saveini]] 
 [[/scid]] 
 [[/scon]] 
 *[[/scripts]]* 
 *[[/scrolltext]]* 
 *[[/search]]* 
 *[[/sendkeys]]* 
 [[/server]] 
 *[[/serverlist]]* 
 [[/set]] 
 *[[/setconfig]]* 
 [[/setlayer]] 
 *[[/setoption]]* 
 *[[/showadiirc]]* 
 *[[/showmenu]]* 
 [[/showmirc]] 
 [[/signal]] 
 *[[/slap]]* 
 *[[/sleep]]* 
 [[/sline]] 
 [[/sockaccept]] 
 [[/sockclose]] 
 [[/socklist]] 
 [[/socklisten]] 
 [[/sockmark]] 
 [[/sockopen]] 
 [[/sockpause]] 
 [[/sockread]] 
  |^. [[/sockrename]] 
 [[/sockudp]] 
 [[/sockwrite]] 
 *[[/sop]]* 
 [[/splay]] 
 [[/sreq]] 
 *[[/statusbar]]* 
 [[/switchbar]] 
 *[[/tab]]* 
 *[[/themes]]* 
 [[/time]] 
 [[/timestamp]] 
 [[/timer]] 
 [[/tip]] 
 [[/tips]] 
 [[/titlebar]] 
 [[/tokenize]] 
 [[/toolbar]] 
 [[/topic]] 
 *[[/topicbox]]* 
 [[/treebar]] 
 [[/ulist]] 
 *[[/usernick]]* 
 *[[/txt2bin]]* 
 *[[/unban]]* 
 *[[/unignore]]* 
 [[/unload]] 
 *[[/unnotify]]* 
 [[/unset]] 
 [[/unsetall]] 
 *[[/update]]* 
 [[/updatenl]] 
 [[/url]] 
 [[/uwho]] 
 [[/var]] 
 *[[/vars]]* 
 *[[/viewlog]]* 
 *[[/voice]]* 
 [[/vol]] 
 *[[/wdown]]* 
 [[/while]] 
 [[/window]] 
 *[[/wjump]]* 
 *[[/wnext]]* 
 *[[/wpause]]* 
  |^. *[[/wplay]]* 
 *[[/wprev]]* 
 [[/write]] 
 [[/writeini]] 
 *[[/wsearch]]* 
 *[[/wseekf]]* 
 *[[/wseekr]]* 
 *[[/wselect]]* 
 *[[/wstop]]* 
 *[[/wup]]* 
 *[[/zip]]* 
  | 

 %(acounter) % 

 h2. System information Commands 

 Output from these are set in [[Options_Dialog|Options]] -> [[Sysinfo Options|Sysinfo]] and are merely convenient aliases. 

 /sysinfo 
 /gfxinfo 
 /cpuinfo 
 /meminfo 
 /diskinfo 
 /audioinfo 
 /uptime 
 /bw 

 h2. Missing Commands 

 /dccserver 
 /dqwindow 
 /finger 
 /flood 
 /flush 
 /fserve 
 /ghide 
 /gload 
 /gmove 
 /gopts 
 /gplay 
 /gpoint 
 /gqreq 
 /gshow 
 /gsize 
 /gstop 
 /gtalk 
 /gunload 
 /ialclear 
 /links 
 /localinfo 
 /pdcc 
 /pop 
 /pvoice 
 /qme 
 /qmsg 
 /registration 
 /save 
 /sound 
 /speak 
 /strip 
 /tnick 
 /tray 
 /vcadd 
 /vcmd 
 /vcrem 
 /vmsg 
 /vnotice 
 /winhelp 
 /wallchops 
 /wallvoices 

 h2. Command prefixes 

 /! prefix will execute the internal command, even if there is a alias with the same name. 

 Example: 

 <pre> 
 ; Override the /me command, 
 alias me { 
   ; use the /! prefix to call the internal command. 
   /!me $1- 
 } 
 </pre> 

 /. prefix can be used to silence the output from many command. 

 Example: 

 <pre> 
 /.msg #channel This message will be hidden from your client, but still sent to the server. 
 </pre> 

 Both prefix's can be used at the same time. 

 Example: 

 <pre> 
 /!.msg #channel This message will be hidden from your client, but still sent to the server. 
 </pre> 

 /!& prefix allows delaying evaluation of the last parameter if the parameter is a %variable, this allows using consecutive spaces in commands such as [[/me]] and [[/msg]]. (AdiIRC only) 

 Example: 

 <pre> 
 ; Put a double spaced text inside the variable '%s'. 
 //var %s test $chr(32) $chr(32) test 

 ; Call the /msg command using the /!& prefix to delay the evaluation of '%s'. 
 /!&msg # %s 
 </pre> 

 h2. Evaluate identifiers from Editbox 

 Typing a command in the Editbox with double slashes// will evaluate [[Scripting Identifiers|$identifiers]] in the line before running it. 
 E.g //echo -ag My nick is $me 

 You can also [[tabcomplete]] [[Scripting Identifiers|$identifiers]] manually using $me<tab>. 

 h2. Creating a new command 

 You can create a new command by opening the menu Tools -> Edit Aliases. 

 The format for the command is <command> <script to execute>. 

 *Example* 

 <pre> 
 ; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'. 
 /p /part $chan 
 </pre> 

 You can also add a command from the script editor, the syntax there is alias <command> <script to execute> 

 *Example* 

 <pre> 
 ; Creates a new command '/p' which will evaluate and then execute the script '/part $chan'. 
 ; Same as previous example. 
 alias p /part $chan 
 </pre> 

 If you want to use scripts with multiple lines, you can enclose them with {} brackets in both Edit Aliases and Script Editor. 

 *Example* 
 <pre> 
 ; Edit Aliases 
 /p { 
   /echo -ag I am parting $chan 
   /part $chan 
 } 

 ; Script editor 
 alias p { 
   /echo -ag I am parting $chan 
   /part $chan 
 } 
 </pre> 

 Almost all built-in commands can be overridden to execute your own script. 

 *Example* 

 <pre> 
 ; Create your own /part command 
 alias part { 
   /echo -ag I am parting $chan 
   raw PART $chan 
 } 

 ; Create your own /part command, but execute the built-in /part command after executing your own script. 
 alias part { 
   /echo -ag I am parting $chan 

   ; Execute the built-in part command 
   !part $chan 
 } 
 </pre> 

 A command can also be called as a $identifier. 

 *Example* 

 <pre> 
 ; Create a command. 
 alias mycommand { 
   echo -ag I was called as a $iif($isid,identifier,command) 
 } 

 ; Call the command as identifier. 
 //noop $mycommand 

 ; Call the command as a command. 
 /mycommand 
 </pre>