random.md

Random

Summary

Various functions for generating random data

Class Properties

Name	Return Type	Description
insideUnitCircle	Vector2 Read-only	Returns a random 2d point inside a circle of radius 1
insideUnitSphere	Vector3 Read-only	Returns a random 3d point inside a sphere of radius 1
onUnitSphere	Vector3 Read-only	Returns a random 3d point on the surface of a sphere of radius 1
rotation	Rotation Read-only	Returns a random rotation
rotationUniform	Rotation Read-only	Returns a random rotation with uniform distribution
value	number Read-only	Returns a random number between 0 and 1
color	Color Read-only	Returns a random color

Class Methods

Random:ColorHSV(hueMin, hueMax, saturationMin, saturationMax, valueMin, valueMax)

Returns a random color within given ranges

Returns: Color (The new random color)

Parameters:

Name	Type	Default	Description
hueMin	number		Minimum hue
hueMax	number		Maximum hue
saturationMin	number		Minimum saturation
saturationMax	number		Maximum saturation
valueMin	number		Minimum brightness
valueMax	number		Maximum brightness

Example

myColor = Random:ColorHSV(0, 1, 0.8, 1, 0.5, 1)

Random:InitState(seed)

Initializes the random number generator with a specified seed

Returns: nil

Parameters:

Name	Type	Default	Description
seed	number		The seed for the random number generator

Example

Random:InitState(seed)

Random:Range(min, max)

Returns a random float number between min and max (inclusive

Returns: number (A random whole number >= min and <= max)

Parameters:

Name	Type	Default	Description
min	number		Minimum value
max	number		Maximum value

Example

value = Random:Range(1, 6)

Random:Range(min, max)

Returns a random float number between min and max

Returns: number (The random number >= min and <= max)

Parameters:

Name	Type	Default	Description
min	number		Minimum value
max	number		Maximum value

Example

value = Random:Range(-1, 1)