home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / bx75p3.zip / doc / README.hooks < prev    next >
Text File  |  1999-02-23  |  5KB  |  339 lines
  1. This is some information provided for script writers about the extra hooks
  2. that BitchX provides for you. You can either use these or not depending on
  3. what you like to see. This list is being added to and I will try and keep
  4. this file updated for them. Thanks to "suicide" for pushing me into this :)
  5. suicide writes the Whirred script for BitchX
  6.  
  7. MSGLOG  returns  
  8.     timestr 
  9.     type 
  10.     from 
  11.     what they sent.
  12.     -or-
  13.     timestr
  14.     "On"
  15.     fully expanded filename
  16.     -or-
  17.     timestr
  18.     "Off"
  19.  
  20. BANS returns 
  21.     the number we consider this to be
  22.     channel
  23.     the ban itself
  24.     who set it.
  25. BANS_HEADER
  26.  
  27. CDCC_PREPACK
  28. CDCC_POSTPACK
  29.     type   NOTICE or PRIVMSG
  30.     from
  31.     nickname
  32.     active dcc's
  33.     send limit
  34.     number in the queue
  35.     queue limit
  36.     max dcc rate out
  37.     number of bytes sent in this session.
  38.     max dcc rate in
  39.     number of bytes received in this session.
  40.     total size of the packs we're offering
  41.     minimum dcc speed we require.
  42.  
  43. CDCC_PACK
  44.     type    NOTICE or PRIVMSG
  45.     channel
  46.     num of this pack
  47.     number of files in this pack
  48.     size of this pack
  49.     number of gets for this pack
  50.     the description.
  51.  
  52. CDCC_NOTE
  53.     type   NOTICE or PRIVMSG
  54.     channel
  55.     note for this package
  56.  
  57. CDCC_QUEUE
  58.     nick
  59.     time
  60.     pack num
  61.     number of files
  62.     description
  63.  
  64. BOT_LIST
  65.     Auto op
  66.     protected
  67.     nick
  68.     channels comma separated.
  69.     host
  70. BOTLIST_HEADER
  71.  
  72. CHANNEL_SYNCH
  73.     channel
  74.     time to join
  75.  
  76. KICK_LIST
  77.     who
  78.     from
  79.     channel
  80.     comment
  81. DCC_HEADER      /* display before DCC_STAT* */
  82.     "Dccnum"
  83.     "type"
  84.     "num"
  85.     "status"
  86.     "K/s"
  87.     "File"
  88.     "Encrypt"
  89. DCC_POST        /* display after DCC_STAT*  */
  90.     "Dccnum"
  91.     "type"
  92.     "num"
  93.     "status"
  94.     "K/s"
  95.     "File"
  96.     "Encrypt"
  97.  
  98. DCC_STAT
  99.     /* this hook displays only dcc like chat's raw etc */
  100.     number
  101.     type
  102.     user
  103.     status
  104.     "N/A"
  105.     Description
  106.     "E" for encrypted or nothing.
  107.  
  108. DCC_STATF
  109.     /* this hook should only display files being transfered */
  110.     Same as above.
  111.     except kilobytes instead of "N/A"
  112.  
  113. DCC_STATF1
  114.     percentage of file transfer'd
  115.     bytes transferred.
  116.     filesize
  117.     minutes
  118.     seconds
  119.  
  120. DCC_TRANSFER_STAT
  121.     /* for /dcc stats command */
  122.     bytes in
  123.     max rate in
  124.     min rate in
  125.     bytes out
  126.     max rate out
  127.     min rate out
  128.     number of dcc's
  129.     active dcc's
  130.     send limit
  131.     Dcc Auto get "On" or "Off"
  132.     show dcc paths "On" or "Off"
  133.     Dcc quiet mode "On" or "Off"
  134.     Dcc overwrite mode "On" or "Off"
  135.  
  136. JOIN_ME
  137.     channel we just joined.
  138.     /* useful for setting individual channel cset's */
  139. LLOOK_JOIN
  140.     name of server
  141.     name of server link
  142.     hopcount
  143.  
  144. LLOOK_ADDED
  145.     name of server
  146.     name of server link
  147.     hopcount
  148.  
  149. LLOOK_SPLIT
  150.     name of server
  151.     name of server link
  152.     hopcount
  153.  
  154. STAT_HEADER
  155.     Nick
  156.     Dop
  157.     kicks
  158.     nicks
  159.     publics
  160.  
  161. STAT
  162.     nick
  163.     dop count
  164.     kick count
  165.     nick change count
  166.     public count
  167.  
  168. USERS_HEADER
  169.     Level
  170.     Auto op
  171.     protection
  172.     Channel
  173.     Nick
  174.     +o
  175.     UserHost
  176.  
  177. USERS
  178.     Users level in our userlist
  179.     Auto op ?
  180.     Protect ?
  181.     Channel/Channels comma separated.
  182.     nickname
  183.     Hostname
  184.     chanop ? '@' :''
  185.  
  186. USERLIST
  187.     Level
  188.     Aop
  189.     Prot
  190.     nick
  191.     host
  192.     channel(s) comma separated.
  193.     Password
  194. USERLIST_HEADER
  195.  
  196. NOTIFY_SIGNOFF_UH
  197.     Nick
  198.     username
  199.     hostname
  200.  
  201. NOTIFY_SIGNON_UH
  202.     Nick
  203.     Username
  204.     Hostname
  205.  
  206. SAVEFILE
  207.     Userlist and count
  208.     -or-
  209.     ShitList and count
  210.     -or-
  211.     AutoJoin and count
  212.     -or-
  213.     BotList and count
  214.     -or-
  215.     Notify and count
  216.     -or-
  217.     Idle and count
  218.     -or-
  219.     BanWord and count
  220.         
  221. SAVEFILEPOST
  222. SAVEFILEPRE
  223.     name of file we are saving to
  224.     expanded name of file.
  225.  
  226. SERVER_NOTICE_FAKES
  227. SERVER_NOTICE_FAKES_MYCHANNEL
  228. SERVER_NOTICE_FOREIGN_KILL
  229. SERVER_NOTICE_KILL
  230. SERVER_NOTICE_LOCAL_KILL
  231. SERVER_NOTICE_SERVER_KILL
  232.     for nickname
  233.     from who
  234.     reason
  235.     server
  236.     other
  237.     /* note some of these depend on /set's being on in order to provide
  238.        the information. SHOW_UNAUTH's SHOW_FAKES, SHOW_SERVER_KILLS,
  239.        SHOW_SERVER_CRAP in particular.
  240.      */
  241.  
  242. SERVER_NOTICE
  243.     depends on /set SHOW_SERVER_CRAP on/off
  244.     from nick
  245.     line to display
  246.  
  247. SHITLIST
  248.     level of shit to apply
  249.     uh filter 
  250.     channel(s) comma separated
  251.     reason for shitlist
  252. SHITLIST_HEADER
  253.  
  254. SHOWIDLE_HEADER
  255.     channel
  256.     idle time allowed
  257.  
  258. SHOWIDLE
  259.     nick
  260.     host
  261.     userlevel in the userlist
  262.     idle time
  263.  
  264. CHANNEL_STATS (32 parameters)
  265.     channel
  266.     complete date time in Mon Jun 10 01:20:03 1996 format. channelcreation
  267.     time on channel in 0d  0h  0m 20s format
  268.     mem usage total size
  269.     mem used by nicklist
  270.     mem used by channellist itself
  271.     mem used by banlist
  272.     stats_ops
  273.     stats_dops
  274.     stats_bans
  275.     stats_unbans
  276.     stats_ops
  277.     stats_dops
  278.     stats_bans
  279.     stats_unbans
  280.     stats_signoffs
  281.     stats_joins
  282.     totalbans
  283.     maxbans
  284.     stats_sops
  285.     stats_sdops
  286.     stats_sbans
  287.     stats_sunbans
  288.     usershere
  289.     usersaway
  290.     chanops
  291.     chanunop
  292.     totalnicks
  293.     maxnicks
  294.     numircops
  295.     ircops         list of nicks that varies.
  296.  
  297. USAGE   /* note still experimenting with this particular hook which may 
  298.        change at any time */
  299.     command
  300.     usage of command
  301.  
  302. DESYNC_MESSAGE
  303.     channel
  304.     server
  305.  
  306. HELPSUBJECT /* output from /chelp */
  307.     name
  308.     output
  309.  
  310. HELPTOPIC /* output from /chelp */
  311.     name
  312.  
  313. WHOLEFT /* this list is expired after 20 minutes for those on the userlist
  314.         and 10 minutes on the regular list. */
  315.     nick
  316.     userhost
  317.     channel
  318.     seconds since split
  319.     their server
  320.     my server
  321. WHOLEFT_HEADER
  322.  
  323. USERS_SERVER
  324.     nick
  325.     server
  326. USERS_SERVER_HEADER
  327.  
  328. AR_REPLY /* when the user presses ^] this hook is called with auto_reply
  329.             nick to use passed to it. */
  330.     nick 
  331.  
  332. CLONE_READ
  333.     /* When information is ready on a socket this hook is called once
  334.        until $readsocket() is used.
  335.         */
  336.         socket number
  337.         server name
  338.         port
  339.