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

Light Theme

Dark Theme

USoundNodeRandom

Selects sounds from a random set

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundNode

USoundNodeRandom

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Sound/SoundNodeRandom.h
Include	#include "Sound/SoundNodeRandom.h"

Syntax

class USoundNodeRandom : public USoundNode

Remarks

Selects sounds from a random set

Variables

	Name	Description
uint8: 1	bRandomizeWithoutReplacement	Determines whether or not this SoundNodeRandom should randomize with or without replacement.
uint8: 1	bShouldExcludeFromBranchCulling	If set to true, this random node will not be culled on load for platforms with a maximum amount of preloaded random branches set in project settings
uint8: 1	bSoundCueExcludedFromBranchCulling	Exclusion for branch culling set by the sound cue.
TArray< bool >	HasBeenUsed	Internal state of which sounds have been played.
int32	NumRandomUsed	Counter var so we don't have to count all of the used sounds each time we choose a sound
TArray< int32 >	PIEHiddenNodes	Editor only list of nodes hidden to duplicate behavior of PreselectAtLevelLoad
int32	PreselectAtLevelLoad	If greater than 0, then upon each level load such a number of inputs will be randomly selected and the rest will be removed.
TArray< float >	Weights

Constructors

	Name	Description
	USoundNodeRandom ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	int32	ChooseNodeIndex ( FActiveSound& ActiveSound )
	void	FixHasBeenUsedArray()
	void	FixWeightsArray()
	void	ParseNodes ( FAudioDevice* AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound, const FSoundParseParameters& Parse..., TArray< FWaveInstance* >& Wav... )
	void	UpdatePIEHiddenNodes()

Overridden from USoundNode

	Name	Description
void	CreateStartingConnectors()	Editor interface.
int32	GetMaxChildNodes()	Returns the maximum number of child nodes this node can possibly have
int32	GetNumSounds ( const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound )	Returns the number of simultaneous sounds this node instance plays back.
void	InsertChildNode ( int32 Index )
void	OnBeginPIE ( const bool bIsSimulating )	Called as PIE begins
void	RemoveChildNode ( int32 Index )
void	SetChildNodes ( TArray< USoundNode* >& InChil... )	Ensure Random weights and usage array matches new amount of children

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

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

Take our survey

Dismiss