USoundNodeDistanceCrossFade Class Reference

SoundNodeDistanceCrossFade. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from USoundNode
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
CrossFade
TArray< FDistanceDatum >	CrossFadeInput
	Each input needs to have the correct data filled in so the SoundNodeDistanceCrossFade is able to determine which sounds to play.
Public Attributes inherited from USoundNode
TArray< TObjectPtr< USoundNode > >	ChildNodes
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Detailed Description

SoundNodeDistanceCrossFade.

This node's purpose is to play different sounds based on the distance to the listener. The node mixes between the N different sounds which are valid for the distance. One should think of a SoundNodeDistanceCrossFade as Mixer node which determines the set of nodes to "mix in" based on their distance to the sound.

Example: You have a gun that plays a fire sound. At long distances you want a different sound than if you were up close. So you use a SoundNodeDistanceCrossFade which will calculate the distance a listener is from the sound and play either: short distance, long distance, mix of short and long sounds.

A SoundNodeDistanceCrossFade differs from an SoundNodeAttenuation in that any sound is only going be played if it is within the MinRadius and MaxRadius. So if you want the short distance sound to be heard by people close to it, the MinRadius should probably be 0

The volume curve for a SoundNodeDistanceCrossFade will look like this:

                     Volume (of the input)

FadeInDistance.Max --> _________________ <– FadeOutDistance.Min / \ / \ / \ FadeInDistance.Min -->/ \ <– FadeOutDistance.Max

Member Function Documentation

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

CrossFadeInput

TArray<FDistanceDatum> CrossFadeInput

Each input needs to have the correct data filled in so the SoundNodeDistanceCrossFade is able to determine which sounds to play.