UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFloatDistribution Class Reference

#include <DistributionFloat.h>

Public Member Functions

 FFloatDistribution ()
 
void GetValue (float Time, float *RESTRICT OutValue) const
 
void GetRandomValue (float Time, float *RESTRICT OutValue, FRandomStream &RandomStream) const
 
void GetRange (float *OutMin, float *OutMax)
 

Public Attributes

FDistributionLookupTable Table
 

Friends

class FComposableDistribution
 

Detailed Description

Type-safe floating point distribution.

Raw distribution from which one float can be looked up per entry.

Constructor & Destructor Documentation

◆ FFloatDistribution()

FFloatDistribution::FFloatDistribution ( )

Default constructor.

Member Function Documentation

◆ GetRandomValue()

void FFloatDistribution::GetRandomValue ( float  Time,
float *RESTRICT  OutValue,
FRandomStream RandomStream 
) const
inline

Samples a value randomly distributed between two values.

Parameters
Time- Time at which to sample the distribution.
OutValue- Upon return contains the sampled value.
RandomStream- Random stream from which to retrieve random fractions.

◆ GetRange()

void FFloatDistribution::GetRange ( float OutMin,
float OutMax 
)
inline

Computes the range of the distribution.

Parameters
OutMin- The minimum value in the distribution.
OutMax- The maximum value in the distribution.

◆ GetValue()

void FFloatDistribution::GetValue ( float  Time,
float *RESTRICT  OutValue 
) const
inline

Samples a value from the distribution.

Parameters
Time- Time at which to sample the distribution.
OutValue- Upon return contains the sampled value.

Friends And Related Symbol Documentation

◆ FComposableDistribution

This distribution is built from composable distributions.

Member Data Documentation

◆ Table

FDistributionLookupTable FFloatDistribution::Table

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