Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Math > FRandomStream

Light Theme

Dark Theme

FRandomStream

Implements a thread-safe SRand based RNG.

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Math/RandomStream.h
Include	#include "Math/RandomStream.h"

Syntax

struct FRandomStream

Remarks

Implements a thread-safe SRand based RNG.

Very bad quality in the lower bits. Don't use the modulus (%) operator.

Constructors

	Name	Description
	FRandomStream()	Default constructor. The seed should be set prior to use.
	FRandomStream ( int32 InSeed )	Creates and initializes a new random stream from the specified seed value.
	FRandomStream ( FName InName )	Creates and initializes a new random stream from the specified name.

Name

Description

FRandomStream()

Default constructor.

The seed should be set prior to use.

FRandomStream

(
int32 InSeed
)

Creates and initializes a new random stream from the specified seed value.

FRandomStream

(
FName InName
)

Creates and initializes a new random stream from the specified name.

Functions

	Name	Description
bool	ExportTextItem ( FString& ValueStr, FRandomStream const& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )	Exports the RandomStreams value to a string.
float	FRand()	Mirrors the random number API in FMath
float	FRandRange ( float InMin, float InMax )	Helper function for rand implementations.
void	GenerateNewSeed()	Generates a new random seed.
int32	GetCurrentSeed()	Gets the current seed.
float	GetFraction()	Returns a random float number in the range [0, 1).
int32	GetInitialSeed()
FVector	GetUnitVector()	Returns a random vector of unit size.
uint32	GetUnsignedInt()	Returns a random number between 0 and MAXUINT.
void	Initialize ( FName InName )	Initializes this random stream using the specified name.
void	Initialize ( int32 InSeed )	Initializes this random stream with the specified seed value.
void	MutateSeed()	Mutates the current seed into the next seed.
int32	RandHelper ( int32 A )	Helper function for rand implementations.
int32	RandRange ( int32 Min, int32 Max )	Helper function for rand implementations.
void	Reset()	Resets this random stream to the initial seed value.
FString	ToString()	Get a textual representation of the RandomStream.
FVector	VRand()	Returns a random vector of unit size.
FVector	VRandCone ( FVector const& Dir, float ConeHalfAngleRad )	Returns a random unit vector, uniformly distributed, within the specified cone.
FVector	VRandCone ( FVector const& Dir, float HorizontalConeHalfAngleRad, float VerticalConeHalfAngleRad )	Returns a random unit vector, uniformly distributed, within the specified cone.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss