VRandom Class Reference

A Random Number Generator class that outputs to multiple types of values, uses the Mersenne Twister algoritm. More...

#include <VRandom.h>

Public Member Functions
	VRandom (unsigned int seed)
void	Reset ()
	Reset RNG, when no initial seed is passed in, the current system time in milliseconds is used as the initial seed.
void	Reset (unsigned int seed)
float	GetFloat (float max, float min=0)
int	GetInt (int max, int min=0)
bool	GetBool (float chance=50.0f)
sf::Color	GetColor (sf::Color max, sf::Color min)
sf::Vector2f	GetVector2f (sf::Vector2f max, sf::Vector2f min=sf::Vector2f())
sf::Vector2i	GetVector2i (sf::Vector2i max, sf::Vector2i min=sf::Vector2i())
sf::Vector2u	GetVector2u (sf::Vector2u max, sf::Vector2u min=sf::Vector2u())

Detailed Description

A Random Number Generator class that outputs to multiple types of values, uses the Mersenne Twister algoritm.

Constructor & Destructor Documentation

VRandom()

VRandom::VRandom ( unsigned int  seed )

inline

Parameters

seed	The game's initial seed.

Member Function Documentation

GetBool()

bool VRandom::GetBool

(

float

chance = 50.0f

)

Gets a random bool based on a random float between 0 - 100.

Parameters

chance

When the generated value is less than this parameter, the value returned will be true.

Returns

The resulting generated value.

GetColor()

sf::Color VRandom::GetColor	(	sf::Color	max,
		sf::Color	min
	)

Get random sf::Color.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

GetFloat()

float VRandom::GetFloat	(	float	max,
		float	min = 0
	)

Get random float.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

GetInt()

int VRandom::GetInt	(	int	max,
		int	min = 0
	)

Get random signed integer.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

GetVector2f()

sf::Vector2f VRandom::GetVector2f	(	sf::Vector2f	max,
		sf::Vector2f	min = sf::Vector2f()
	)

Get random two-dimensional float.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

GetVector2i()

sf::Vector2i VRandom::GetVector2i	(	sf::Vector2i	max,
		sf::Vector2i	min = sf::Vector2i()
	)

Get random two-dimensional signed integer.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

GetVector2u()

sf::Vector2u VRandom::GetVector2u	(	sf::Vector2u	max,
		sf::Vector2u	min = sf::Vector2u()
	)

Get random two-dimensional unsigned integer.

Parameters

max	The highest value the random number can generate.
min	The lowest value the random number can generate (must be less than max).

Returns

The resulting generated value.

Reset()

void VRandom::Reset ( unsigned int  seed )

inline

Reset RNG seed.

Parameters

seed	Initial Seed for RNG.

---

The documentation for this class was generated from the following file:

• D:/Development/Libs/Vigilante-Game-Framework/VFrame/VRandom.h