webgui/lib/WebGUI/Macro/Splat_random.pm
2009-02-20 23:47:30 +00:00

50 lines
1.2 KiB
Perl

package WebGUI::Macro::Splat_random;
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2009 Plain Black Corporation.
#-------------------------------------------------------------------
# Please read the legal notices (docs/legal.txt) and the license
# (docs/license.txt) that came with this distribution before using
# this software.
#-------------------------------------------------------------------
# http://www.plainblack.com info@plainblack.com
#-------------------------------------------------------------------
use strict;
use WebGUI::Utility;
=head1 NAME
Package WebGUI::Macro::Splat_random
=head1 DESCRIPTION
Macro for returning a bounded, integer random number.
#-------------------------------------------------------------------
=head2 process ( max )
Random numbers are truncated to integer values.
=head3 max
The upper bound for the random number. If omitted, 1_000_000_000 is
used as a default.
=cut
sub process {
my $session = shift;
my (@param, $limit);
@param = @_;
if ($param[0] ne "") {
$limit = $param[0];
} else {
$limit = 1000000000;
}
return int(rand($limit));
}
1;