GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  IRC::BOT::HANGMAN (3)

.ds Aq ’

NAME

IRC::Bot::Hangman - An IRC hangman

CONTENTS

SYNOPSIS



  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\n";



COMMANDS



  <letter>? : guess a letter
  guess <letter> : guess a letter
  guess <word> : guess an entire word
  <hangman> help - help instructions
  <hangman> play : Start a new game or display current game
  <hangman> quiet : keep quiet between guesses
  <hangman> talk : Talk between guesses



DESCRIPTION

This module provides a useless IRC 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.

The main motivation was to provide a multi-player text based game for children to help them practising writing.

PLUGINS

The plugins are managed by



  IRC::Bot::Hangman::WordList
  IRC::Bot::Hangman::Command
  IRC::Bot::Hangman::Response



METHODS

word_list( CW$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.

    load_word_list( name )

Returns a default english words list from IRC::Bot::Hangman::WordList

word_list_name( CW$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

    games( integer )

Get or set the number of games before ending. undef means infinity.

game( CW$game )

Get or set the hangman game. The default value is a Games::GuessWord instance with word_list() word list.

new_game()

Reset the game

replay()

Reset the game unless it is the last game as counted by games()

can_talk()

Get set can_talk, used by tick to display reminders.

load_game()

Returns a Games::GuessWord instance

msg_guess()

Displays the word to guess

get_delay()

Returns a random time calculated: delay() * (1 + rand(4)) seconds

delay()

Get set base delay in seconds. Default is 30s.

input()

Get/set input

response()

Get/set response

    set_response( type )

Sets the response from a response type

    get_a_msg( type )

Returns a msg of a given type

    guess_word( word )

Guess a word : success or one chance less

    guess_letter( letter )

Guess a letter : match or one chance less

conclusion()

Displays an end of game message : sucess or lost

    give_advice( guess )

Bot::BasicBot METHODS

These are the Bot::BasicBot overriden methods

said( CW$args )

This is the main method, everything said is analysed to provide a reply if appropriate

help()

Displays help when called hangman help

tick()

Called every now and then to display a reminder if the game is active and can_talk is on.

SEE ALSO

Bot::BasicBot

AUTHOR

Pierre Denis <pierre@itrelease.net>

http://www.itrelease.net/

COPYRIGHT

Copyright 2005 IT Release Ltd - All Rights Reserved.

This module is released under the same license as Perl itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 IRC::BOT::HANGMAN (3) 2016-04-04

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.