SBL Language ReferenceAll Packages | All Classes | Index | Frames
Rand
 
Packagecom.joebillman.utils
Classpublic class Rand
InheritanceRand Inheritance Object

Rand: This is a useful class for generating random items.

View the examples



Public Properties
 PropertyDefined By
  instance : Rand
[static] [read-only]
Rand
  pointer : uint
trace(Rndm.pointer); traces the current position in the number series Rndm.pointer = 50; moves the pointer to the 50th number in the series
Rand
  seed : uint
seed = Math.random()xFFFFFF; sets a random seed seed = 50; sets a static seed
Rand
Public Methods
 MethodDefined By
  
Rand(seed:uint = 0)
Constructor.
Rand
  
array(src:Array):void
This function ranodmizes an array.
Rand
  
array(src:Array):void
[static]
Rand
  
bit(chance:Number = 0.5):int
bit(); returns 1 or 0 (50% chance of 1) bit(0.8); returns 1 or 0 (80% chance of 1)
Rand
  
bit(chance:Number = 0.5):int
[static]
Rand
  
boolean(chance:Number = 0.5):Boolean
boolean(); returns true or false (50% chance of true) boolean(0.8); returns true or false (80% chance of true)
Rand
  
boolean(chance:Number = 0.5):Boolean
[static]
Rand
  
color():Object
This function returns a random color.
Rand
  
color():Object
[static]
Rand
  
integer(min:Number, max:Number):int
integer(50); returns an integer between 0-50 inclusive.
Rand
  
integer(min:Number, max:Number):int
[static]
Rand
  
number(min:Number, max:Number):Number
number(50); returns a number between 0-50 exclusive number(20,50); returns a number between 20-50 exclusive
Rand
  
number(min:Number, max:Number):Number
[static]
Rand
  
random():Number
random(); returns a number between 0-1 exclusive.
Rand
  
random():Number
[static]
Rand
  
reset():void
reset(); resets the number series, retaining the same seed
Rand
  
reset():void
[static]
Rand
  
sign(chance:Number = 0.5):int
sign(); returns 1 or -1 (50% chance of 1) sign(0.8); returns 1 or -1 (80% chance of 1)
Rand
  
sign(chance:Number = 0.5):int
[static]
Rand
  
vector(src:*):void
This function ranodmizes a vector.
Rand
  
vector(src:*):void
[static]
Rand
Property Detail
instanceproperty
instance:Rand  [read-only]


Implementation
    public static function get instance():Rand
pointerproperty 
public var pointer:uint

trace(Rndm.pointer); traces the current position in the number series Rndm.pointer = 50; moves the pointer to the 50th number in the series

seedproperty 
public var seed:uint

seed = Math.random()xFFFFFF; sets a random seed seed = 50; sets a static seed

Constructor Detail
Rand()Constructor
public function Rand(seed:uint = 0)

Constructor.

Parameters
seed:uint (default = 0)
Method Detail
array()method
public function array(src:Array):void

This function ranodmizes an array.

Parameters

src:Array — array values from which to randomize.

array()method 
public static function array(src:Array):void

Parameters

src:Array

bit()method 
public function bit(chance:Number = 0.5):int

bit(); returns 1 or 0 (50% chance of 1) bit(0.8); returns 1 or 0 (80% chance of 1)

Parameters

chance:Number (default = 0.5)

Returns
int
bit()method 
public static function bit(chance:Number = 0.5):int

Parameters

chance:Number (default = 0.5)

Returns
int
boolean()method 
public function boolean(chance:Number = 0.5):Boolean

boolean(); returns true or false (50% chance of true) boolean(0.8); returns true or false (80% chance of true)

Parameters

chance:Number (default = 0.5)

Returns
Boolean
boolean()method 
public static function boolean(chance:Number = 0.5):Boolean

Parameters

chance:Number (default = 0.5)

Returns
Boolean
color()method 
public function color():Object

This function returns a random color.

Returns
Object
color()method 
public static function color():Object

Returns
Object
integer()method 
public function integer(min:Number, max:Number):int

integer(50); returns an integer between 0-50 inclusive. (Joe) I modified this by adding 1 to max so that it would include it. integer(20,50); returns an integer between 20-50 inclusive

Parameters

min:Number
 
max:Number (default = NaN)

Returns
int
integer()method 
public static function integer(min:Number, max:Number):int

Parameters

min:Number
 
max:Number (default = NaN)

Returns
int
number()method 
public function number(min:Number, max:Number):Number

number(50); returns a number between 0-50 exclusive number(20,50); returns a number between 20-50 exclusive

Parameters

min:Number
 
max:Number (default = NaN)

Returns
Number
number()method 
public static function number(min:Number, max:Number):Number

Parameters

min:Number
 
max:Number (default = NaN)

Returns
Number
random()method 
public function random():Number

random(); returns a number between 0-1 exclusive.

Returns
Number
random()method 
public static function random():Number

Returns
Number
reset()method 
public function reset():void

reset(); resets the number series, retaining the same seed

reset()method 
public static function reset():void

sign()method 
public function sign(chance:Number = 0.5):int

sign(); returns 1 or -1 (50% chance of 1) sign(0.8); returns 1 or -1 (80% chance of 1)

Parameters

chance:Number (default = 0.5)

Returns
int
sign()method 
public static function sign(chance:Number = 0.5):int

Parameters

chance:Number (default = 0.5)

Returns
int
vector()method 
public function vector(src:*):void

This function ranodmizes a vector.

Parameters

src:* — vector values from which to randomize.

vector()method 
public static function vector(src:*):void

Parameters

src:*

Examples
The following example illustrates basic usage.
     Rand.seed = Math.random()xFFFFFF;
     Rand.integer(-10, 10);