/ 
Acme-Dice-1.01
River stage zero No dependents
/ Acme::Dice

NAME

Acme::Dice - The finest in croo ..., uhhh, precision dice!

SYNOPSIS

use Acme::Dice qw(roll_dice roll_craps);
  
my $total = roll_dice( dice => 3, sides => 6, favor => 6, bias => 30 );
my @dice = roll_dice( dice => 3, sides => 6, favor => 6, bias => 30 );
  
my $craps_roll = roll_craps( bias => 30 );
my @craps_dice = roll_craps( bias => 30 );

DESCRIPTION

Acme knows that sometimes one needs more flexibility in one's rolls than using normal dice normally allows. Here at last is a package that gives one exactly the flexibility that has been lacking.

With Acme::Dice, not only can one specify the number and type of dice to be rolled, not only can one choose to have just the total number or the individual die results returned, but one can exert some amount of influence over the outcome as well!

FUNCTIONS

Nothing is EXPORTed by default, However, the following functions are available as imports.

roll_dice

This is the primary function. It accepts the parameters listed below to control behavior and will return either the sum of the rolls or an array containing the results of individual dice rolls depending upon context.

my $total = roll_dice( dice => 3, sides => 6, favor => 6, bias => 30 );
my @dice = roll_dice( dice => 3, sides => 6, favor => 6, bias => 30 );

The two examples above both roll three six-sided dice with a 30% bias in favor of rolling a six (6) on each die. The first returns the total of the three dice in a scalar, and the second returns an array with the individual rolls.

All parameters are optional, and if the function is called with no parameters it will roll a single 6-sided die with no bias.

The parameters are as follows:

dice

This is an integer specifying the number of dice to roll. Default: 1

An exception will be thrown if it is less than 1 or greater than 100.

sides

This is an integer specifying how many sides are on the dice to be rolled. Default: 6

An exception will be thrown if it is less than 1. (Huh? A 1-sided die? Nothing is impossible for Acme!)

favor

This integer specifies which number (if any) should be favored and must be between 0 and the value specified for sides. A value of 0 disables any bias even if a value for bias is given. Default: 0

bias

This is an integer between 0 and 100 that determines how much "weight" to place on the favored side. A value of 20 says to increase the chance of rolling the favored number by 20%. A value of 100 would mean to always roll the favored number. A value of 0 will disable favoring completely, even if a value for favor is given. Default: 0

An exception will be thrown if the value is less than 0 or greater than 100.

roll_craps

This function is sugar for roll_dice that automatically rolls two 6-sided dice. It will also automatically adjust the favor parameter for "3" and "4" as appropriate if a value for bias is given, simulating "loaded" dice.

Like roll_dice, the return value depends upon context.

my $total = roll_craps( bias => 30 );
my @dice = roll_craps( bias => 30 );

It will only accept a single, optional parameter: bias

The bias parameter behaves the same as described above for roll_dice. Any other parameters, including those that are otherwise legal for roll_dice, will cause an exception to be thrown.

The default is an un-biased roll of two 6-sided dice.

BUGS

Bugs? In an Acme module?!? Yeah, right.

SUPPORT

Support is provided by the author. Please report bugs or make feature requests to the author or use the GitHub repository:

http://github.com/boftx/Acme-Dice

AUTHOR

Jim Bacon <jim@nortx.com>

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.

DISCLAIMER

Finding a way to use this module, and the consequences of doing so, is the sole responsibility of the user!

NOTE

Acme employs the finest technology available to ensure the quality of its products. There are no user-servicable parts inside. For your own safety, DO NOT EXAMINE THE CONTENTS OF THIS PACKAGE!