Games::Bingo::Bot - A simple class holding IRC related methods for bingo
use Games::Bingo::Bot;
use constant ANY => 1; use constant PUBLIC => 2; use constant PRIVATE => 3;
my $gbb = Games::Bingo::Bot->new();
my $sub = $gbb->{'commands'}->{$msg});
my ($type, $answer) = &$sub($gbb, $nick);
This module contains all the commands supported by the Games::Bingo::Bot IRC bot (see the script in the bin directory).
The Games::Bingo::Bot class (this) and the script mentioned above is a complete IRC setup for playing Bingo, using the Games::Bingo module.
These are the bingobot commands:
The command are described below in detail (SEE COMMANDS).
Not implemented yet (SEE TODO):
All commands can be sent into the channel or send as private messages to the bot. The bot can repond as both of these ways aswell. The reponses are sent as follows:
As long as the bot is online a game is running.
These are the basic methods of the class.
This is the constructor, it will start up a new game.
This is the only method apart from the contructor new, which is not a implementation of a IRC related command.
The method returns a CODEREF to the command asked for (SEE COMMANDS).
All these methods are implementations of commands which are supported by the IRC client.
This is the command to be issued by a user, when he/she has bingo.
This starts a check of the issuing players card.
The method takes one argument, the nick of the player.
The methods reponds publicly on success and privately when the player did not have a bingo.
This command issues the pulling of a new number.
The method takes no arguments. The method responds publicly.
This command shows the card of the player issuing the command.
The method takes one argument, the nick of the player. The method reponds privately.
This command shows the current stats of the game.
The method takes no arguments. The method responds according to how it was called (publicly/privately).
This method shows the numbers which have been pulled.
The method takes no arguments. The method responds according to how it was called (publicly/privately).
This method adds the issuing player to the current game.
The method takes one argument, the nick of the player. The method responds according to how it was called (publicly/privately).
This method deletes the issueing player from the current game.
The method takes one argument, the nick of the player. The method responds according to how it was called (publicly/privately).
*This is not yet implemented, please see the TODO*
This is actually a simple accessor, enabling the autoflag of the game, meaning numbers are pulled automatically.
The method takes no argument. The method responds according to how it was called (publicly/privately).
*This is not yet implemented, please see the TODO*
This is actually a simple accessor, disabling the autoflag of the game, meaning numbers are no longer pulled automatically.
The method takes no argument. The method responds according to how it was called (publicly/privately).
This is a simple list of the commands and a few guidelines, a reference manual so to speak.
The method takes no argument. The method responds privately.
jonasbn <jonasbn@cpan.org>
Games::Bingo::Bot and related scripts and modules are free software and is released under the Artistic License. See <http://www.perl.com/language/misc/Artistic.html> for details.
Games::Bingo::Bot is (C) 2003 Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org>
