.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "IRC::Bot::Hangman 3" .TH IRC::Bot::Hangman 3 "2008-01-04" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" IRC::Bot::Hangman \- An IRC hangman .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& use IRC::Bot::Hangman; \& IRC::Bot::Hangman->new( \& channels => [ '#hangman' ], \& nick => 'hangman', \& server => 'irc.blablablablah.bla', \& word_list_name => 'too_easy', \& games => 3, \& )->run; \& print "Finished\en"; .Ve .SH "COMMANDS" .IX Header "COMMANDS" .Vb 7 \& ? : guess a letter \& guess : guess a letter \& guess : guess an entire word \& help - help instructions \& play : Start a new game or display current game \& quiet : keep quiet between guesses \& talk : Talk between guesses .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a useless \s-1IRC\s0 bot which enables you to play hangman, the classic word game. It comes shipped with a list of ~2000 english words by default. The architecture is plugin based, words, commands and responses can be extended at will by adding new modules. .PP The main motivation was to provide a multi-player text based game for children to help them practising writing. .SH "PLUGINS" .IX Header "PLUGINS" The plugins are managed by .PP .Vb 3 \& IRC::Bot::Hangman::WordList \& IRC::Bot::Hangman::Command \& IRC::Bot::Hangman::Response .Ve .SH "METHODS" .IX Header "METHODS" .ie n .Sh "word_list( $list )" .el .Sh "word_list( \f(CW$list\fP )" .IX Subsection "word_list( $list )" Get or set the word list as an array ref. A default word list of ~2000 english words is provided if no list is set. .Sh "load_word_list( name )" .IX Subsection "load_word_list( name )" Returns a default english words list from IRC::Bot::Hangman::WordList .ie n .Sh "word_list_name( $name )" .el .Sh "word_list_name( \f(CW$name\fP )" .IX Subsection "word_list_name( $name )" Get or set the word list name. It must be an installed module in IRC::Bot::Hangman::WordList::xxx The default provided is 'default' = IRC::Bot::Hangman::WordList::Default .Sh "games( integer )" .IX Subsection "games( integer )" Get or set the number of games before ending. undef means infinity. .ie n .Sh "game( $game )" .el .Sh "game( \f(CW$game\fP )" .IX Subsection "game( $game )" Get or set the hangman game. The default value is a Games::GuessWord instance with \fIword_list()\fR word list. .Sh "\fInew_game()\fP" .IX Subsection "new_game()" Reset the game .Sh "\fIreplay()\fP" .IX Subsection "replay()" Reset the game unless it is the last game as counted by \fIgames()\fR .Sh "\fIcan_talk()\fP" .IX Subsection "can_talk()" Get set \f(CW\*(C`can_talk\*(C'\fR, used by \f(CW\*(C`tick\*(C'\fR to display reminders. .Sh "\fIload_game()\fP" .IX Subsection "load_game()" Returns a Games::GuessWord instance .Sh "\fImsg_guess()\fP" .IX Subsection "msg_guess()" Displays the word to guess .Sh "\fIget_delay()\fP" .IX Subsection "get_delay()" Returns a random time calculated: \&\fIdelay()\fR * (1 + \fIrand\fR\|(4)) seconds .Sh "\fIdelay()\fP" .IX Subsection "delay()" Get set base delay in seconds. Default is 30s. .Sh "\fIinput()\fP" .IX Subsection "input()" Get/set input .Sh "\fIresponse()\fP" .IX Subsection "response()" Get/set response .Sh "set_response( type )" .IX Subsection "set_response( type )" Sets the response from a response type .Sh "get_a_msg( type )" .IX Subsection "get_a_msg( type )" Returns a msg of a given type .Sh "guess_word( word )" .IX Subsection "guess_word( word )" Guess a word : success or one chance less .Sh "guess_letter( letter )" .IX Subsection "guess_letter( letter )" Guess a letter : match or one chance less .Sh "\fIconclusion()\fP" .IX Subsection "conclusion()" Displays an end of game message : sucess or lost .Sh "give_advice( guess )" .IX Subsection "give_advice( guess )" .SH "Bot::BasicBot METHODS" .IX Header "Bot::BasicBot METHODS" These are the Bot::BasicBot overriden methods .ie n .Sh "said( $args )" .el .Sh "said( \f(CW$args\fP )" .IX Subsection "said( $args )" This is the main method, everything said is analysed to provide a reply if appropriate .Sh "\fIhelp()\fP" .IX Subsection "help()" Displays help when called \f(CW\*(C`hangman help\*(C'\fR .Sh "\fItick()\fP" .IX Subsection "tick()" Called every now and then to display a reminder if the game is active and \f(CW\*(C`can_talk\*(C'\fR is on. .SH "SEE ALSO" .IX Header "SEE ALSO" Bot::BasicBot .SH "AUTHOR" .IX Header "AUTHOR" Pierre Denis .PP http://www.itrelease.net/ .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2005 \s-1IT\s0 Release Ltd \- All Rights Reserved. .PP This module is released under the same license as Perl itself.