OpenXcom::RNG Namespace Reference

Random Number Generator used throughout the game for all your randomness needs. More...

Functions
uint64_t	getSeed ()
	Returns the current seed in use by the generator. More...
void	setSeed (uint64_t n)
	Changes the current seed in use by the generator. More...
int	generate (int min, int max)
	Generates a random integer number within a certain range. More...
double	generate (double min, double max)
	Generates a random decimal number within a certain range. More...
int	seedless (int min, int max)
	Generates a random integer number within a certain range. More...
double	boxMuller (double m, double s)
	Normal random variate generator. More...
bool	percent (int value)
	Generates a random percent chance of an event occurring, and returns the result. More...
int	generateEx (int max)
	Generates a random positive integer up to a number. More...
template<typename T >
void	shuffle (T &list)
	Shuffles a list randomly. More...

Detailed Description

Random Number Generator used throughout the game for all your randomness needs.

Uses a 64-bit xorshift pseudorandom number generator.

Function Documentation

boxMuller()

double OpenXcom::RNG::boxMuller	(	double	m,
		double	s
	)

Normal random variate generator.

Get normally distributed value.

Parameters

m	mean
s	standard deviation

Returns

normally distributed value.

generate() [1/2]

int OpenXcom::RNG::generate	(	int	min,
		int	max
	)

Generates a random integer number within a certain range.

Generates a random integer number, inclusive.

Parameters

min	Minimum number, inclusive.
max	Maximum number, inclusive.

Returns

Generated number.

generate() [2/2]

double OpenXcom::RNG::generate	(	double	min,
		double	max
	)

Generates a random decimal number within a certain range.

Generates a random floating-point number.

Parameters

min	Minimum number.
max	Maximum number.

Returns

Generated number.

generateEx()

int OpenXcom::RNG::generateEx

(

int

max

)

Generates a random positive integer up to a number.

Generates a random integer number, exclusive.

Parameters

max	Maximum number, exclusive.

Returns

Generated number.

getSeed()

uint64_t OpenXcom::RNG::getSeed

(

)

Returns the current seed in use by the generator.

Gets the seed in use.

Returns

Current seed.

percent()

bool OpenXcom::RNG::percent

(

int

value

)

Generates a random percent chance of an event occurring, and returns the result.

Generates a percentage chance.

Parameters

value

Value percentage (0-100%)

Returns

True if the chance succeeded.

seedless()

int OpenXcom::RNG::seedless	(	int	min,
		int	max
	)

Generates a random integer number within a certain range.

Generates a random integer number, inclusive (non-seed version).

Distinct from "generate" in that it doesn't touch the seed.

Parameters

min	Minimum number, inclusive.
max	Maximum number, inclusive.

Returns

Generated number.

setSeed()

void OpenXcom::RNG::setSeed

(

uint64_t

n

)

Changes the current seed in use by the generator.

Sets the seed in use.

Parameters

n

New seed.

shuffle()

template<typename T >

void OpenXcom::RNG::shuffle

(

T &

list

)

Shuffles a list randomly.

Randomly changes the orders of the elements in a list.

Parameters

list	The container to randomize.