|
NAMEGames::Bingo - a bingo game Perl implementationSYNOPSISuse Games::Bingo; my $bingo = Games::Bingo-E<gt>new(90); my $bingo = Games::Bingo-E<gt>new(); 90 is actually the default my $number = $bingo-E<gt>play(); >> my @taken; $bingo-E<gt>pull(\@pulled, $number); or use Games::Bingo; my $bingo = Games::Bingo-E<gt>new(); my @numbers; $bingo-E<gt>init(\@numbers, 90); my $number = $bingo-E<gt>play(\@numbers); my @taken; $bingo-E<gt>take(\@taken, $number); DESCRIPTIONThis is a simple game of bingo. The program can randomly call out the numbers. The game will be get more features in the future, please refer to the TODO section (below).METHODSThis are the central methods of Games::BingonewThe constructor is quite simple. It can either be called without any paramters and then followed by a call to init see below or the ceiling for the numbers (stored internally) can be given as a parameter, the latter is the recommeded use.If no indicator of the number of numbers you want in your bingo game is given the game defaults to 90. This can be overwritten if using the old API, please refer to the SYNOPSIS. The attributes of the class are the following:
initThis method takes two parameters. An array reference and a ceiling, the method will push numbers onto the array reference from 1 to ceiling (including the ceiling). Initializing the numbers for the game.The use of init is not recommended, use the constructor in the recommended way instead. Returns 1 upon success. playThe play is one of the essential methods in the game, it takes an array reference and returns a random number from the array referenced to. The reference shrinks with one with each call.The recommended way is though to use the internally stored array, where play then takes no arguments, please refer to new and init and the SYNOPSIS. takeThe take method is the memory of the game. It takes to parameters, a reference to an array of arrays (the memory), and additionaly the number picked by e.g. the play method.Since the first program to use the class/module was a console based the take method organizes the numbers in an array of array for a nicer presentation. This will probably be changed later (if necessary). randomThe encapsulation of the rand function. Takes a number as a paramtere and returns a number between 0 and the number given as a parameter just as rand (% perldoc -f rand).The result is rounded down using POSIX::floor pulledA method which return 1 or 0 indicating true or false, whether the number given as a parameter has been pulled._all_pulledA method which returns all pulled numbers as an array.pullA clumsy alias/"overload" implementation of the take method.splitnumberTakes a number (prepends 0 its a single digit number) and returns it split in two (We use this for identifying the column it belongs to).SEE ALSO
TODOThe TODO file contains a complete list for the whole Games::Bingo project.BUGSPlease report issues via CPAN RT:http://rt.cpan.org/NoAuth/Bugs.html?Dist=Games-Bingo or by sending mail to bug-Games-Bingo@rt.cpan.org TEST COVERAGE---------------------------- ------ ------ ------ ------ ------ ------ ------ File stmt bran cond sub pod time total ---------------------------- ------ ------ ------ ------ ------ ------ ------ blib/lib/Games/Bingo.pm 100.0 100.0 100.0 100.0 100.0 22.3 100.0 blib/lib/Games/Bingo/Card.pm 100.0 100.0 66.7 100.0 100.0 21.5 99.4 ...lib/Games/Bingo/Column.pm 100.0 100.0 n/a 100.0 100.0 24.3 100.0 ...Bingo/ColumnCollection.pm 92.5 84.6 33.3 100.0 100.0 31.4 90.6 .../Games/Bingo/Constants.pm 100.0 n/a n/a 100.0 n/a 0.4 100.0 Total 98.2 94.1 62.5 100.0 100.0 100.0 97.4 ---------------------------- ------ ------ ------ ------ ------ ------ ------ AUTHORjonasbn <jonasbn@cpan.org>ACKNOWLEDGEMENTSThis is a compilation of all the people have helped me, their names are also scattered all over the modules where appropriate.
AUTHORJonas B. Nielsen, (jonasbn) - "<jonasbn@cpan.org>"COPYRIGHTGames-Bingo is (C) by Jonas B. Nielsen, (jonasbn) 2003-2015Games-Bingo is released under the artistic license 2.0
Visit the GSP FreeBSD Man Page Interface. |