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 > Plugins > SoundCueTemplates > USoundCueTemplate

Light Theme

Dark Theme

USoundCueTemplate

Base Sound Cue Template class, which builds the sound node graph procedurally and hides more complex Sound Cue functionality to streamline implementation defined in child classes.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

USoundCue

USoundCueTemplate

	USoundCueContainer
	USoundCueDistanceCrossfade

References

Module	SoundCueTemplates
Header	/Engine/Plugins/Runtime/SoundCueTemplates/Source/SoundCueTemplates/Public/SoundCueTemplate.h
Include	#include "SoundCueTemplate.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class USoundCueTemplate : public USoundCue

Remarks

Base Sound Cue Template class, which builds the sound node graph procedurally and hides more complex Sound Cue functionality to streamline implementation defined in child classes.

Constructors

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

Functions

	Name	Description
void	AddSoundNodeChild ( USoundNode& InParentNode, USoundNode& InChildNode, int32 InputPinIndex, const FText* InputPinDisplayNa... )	Utility function that adds a provided child node to a parent node's list of children.
void	AddSoundWaves ( TArray< TWeakObjectPtr< USoundWave ... )	Override to initialize a template with array of sound waves from SoundCueFactory
T &	ConstructSoundNodeChild ( USoundCue& SoundCue, USoundNode* InParentNode, int32 Column, int32 Row, int32 InputPinIndex, const FText* InputPinDisplayNa... )	Utility function that returns newly constructed sound node that has been added to provided SoundCue's Node Graph.
T &	ConstructSoundNodeRoot ( USoundCue& SoundCue )	Constructs initial root sound node of template.
float	GetInitialHeightOffset()	Initial height offset of first node in the SoundCueEditor.
float	GetInitialWidthOffset()	Initial width offset of first node in the SoundCueEditor.
float	GetNodeHeightOffset()	Node height offset between nodes in the SoundCueEditor.
float	GetNodeWidthOffset()	Node width offset between nodes in the SoundCueEditor.
void	OnRebuildGraph ( USoundCue& SoundCue )	Function to override that uses internal editor-data only properties to re-build node graph of provided SoundCue.
void	RebuildGraph ( USoundCue& SoundCue )	Rebuilds the graph when user-facing properties are changed
void	SetSoundNodePosition ( USoundNode& InNode, int32 Column, int32 Row )	Sets the provided node's position to the location on the template's grid

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss