home *** CD-ROM | disk | FTP | other *** search
/ Enter 2003: The Beautiful Scenery / enter-parhaat-2003.iso / files / airc_setup.exe / data1.cab / Documents / scripting.txt < prev   
Encoding:
Text File  |  2002-07-26  |  2.4 KB  |  78 lines
  1. Advanced IRC scripting functions and routines - 1.31
  2. ****************************************************
  3.  
  4. *** Note ***
  5. The variable "retval" is included in every stoppable trigger. If
  6. it is, within the script, set to true, further execution of that
  7. trigger within the program will be stopped after script execution.
  8.  
  9. The above statement may sound confusing, so I'll tell you in another
  10. way. If you have an 'in_msg()' event, and you set the variable 'retval'
  11. to true within that function, the client will not display the message.
  12.  
  13. The scripts are case insensitive.
  14.  
  15.  
  16. ==================
  17. Required functions
  18. ==================
  19.  
  20. Open/close
  21. ----------
  22.  
  23. airc_init(ScName,ScFunc) 'Name of script and function
  24.  
  25. The function 'airc_init' may not contain functions defined within
  26. the script. Only the variables 'ScName' and 'ScFunc' must be set
  27. in this function.
  28.  
  29.  
  30. =============
  31. Optional subs
  32. =============
  33.  
  34. Open/close
  35. ----------
  36.  
  37. airc_close() 'OnClose, a trigger
  38.  
  39. Commands
  40. --------
  41.  
  42. aecho(s,[stdcolor],[drawbrand]) 'Echo to active window
  43. secho(s,[stdcolor],[drawbrand]) 'Echo to status window
  44. echo(s,where,[server],[stdcolor],[drawbrand]) 'Echo to specified window
  45. putignore(where,types) 'Set an ignore
  46. remignore(where,types) 'Remove an ignore
  47. putmsg(text,where) 'Send a privmsg
  48. putnotice(text,where) 'Send a notice
  49. putctcp(text,where) 'Send a ctcp
  50. putctcpreply(text,where) 'Send a ctcp reply
  51. putserver(text,[servernum]) 'Send raw text to server
  52. runcmd(text,[where]) 'Run an internal command
  53. say(text) 'Say something to active window
  54. closequery(nick) 'Close a query window
  55.  
  56. Variables/functions
  57. -------------------
  58.  
  59. fetchhost(nick,hostmode) 'Returns the hostmask for the given nick
  60. searchstr(s1,s2) 'Returns true if s2 is found in s1
  61. activeserver() 'The active server number
  62. factive() 'The active window
  63. curnick() 'Current nickname
  64. isaway() 'Returns TRUE if client is away
  65.  
  66. Triggers/aliases
  67. ----------------
  68.  
  69. in_join(retval,nick,chan) 'OnJoin
  70. in_part(retval,nick,chan) 'OnPart
  71. in_msg(retval,text,nick) 'Private msg
  72. in_chanmsg(retval,text,nick,chan) 'Channel msg
  73. connect(server,port,servernum) 'OnConnect
  74. disconnect(server,port,servernum) 'OnDisconnect
  75. raw(retval,rawnum,text,nick,chan) 'Raw
  76. autoaway(text) 'On auto-away trigger
  77. autoback() 'On auto-back or aborted away
  78. alias_*(retval,text) 'Aliases, where "*" is any word not including spaces or special characters