Navigation
API > API/Plugins > API/Plugins/SoundCueTemplates
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.
| Name | USoundCueTemplate |
| Type | class |
| Header File | /Engine/Plugins/Runtime/SoundCueTemplates/Source/SoundCueTemplates/Public/SoundCueTemplate.h |
| Include Path | #include "SoundCueTemplate.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class USoundCueTemplate : public USoundCue
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USoundBase → USoundCue → USoundCueTemplate
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USoundCueTemplate
(
const FObjectInitializer& ObjectInitializer |
SoundCueTemplate.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddSoundWaves
(
TArray< TWeakObjectPtr< USoundWave > >& Waves |
Override to initialize a template with array of sound waves from SoundCueFactory | SoundCueTemplate.h | |
void AddSoundWavesToTemplate
(
const TArray< UObject* >& SelectedObjects |
SoundCueTemplate.h |
|
|
virtual FString GenerateDefaultNewAssetName
(
const TArray< TWeakObjectPtr< USoundWave > >& Waves |
Override to provide a default new asset name prefix from SoundCueTemplateFactory | SoundCueTemplate.h | |
virtual void LoadTemplateDefaultSettings() |
Override to load template default settings from SoundCueTemplateFactory | SoundCueTemplate.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
SoundCueTemplate.h | ||
void RebuildGraph
(
USoundCue& SoundCue |
Rebuilds the graph when user-facing properties are changed | SoundCueTemplate.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRebuildGraph
(
USoundCue& SoundCue |
Function to override that uses internal editor-data only properties to re-build node graph of provided SoundCue. | SoundCueTemplate.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddSoundNodeChild
(
USoundNode& InParentNode, |
Utility function that adds a provided child node to a parent node's list of children. | SoundCueTemplate.h | |
static T & ConstructSoundNodeChild
(
USoundCue& SoundCue, |
Utility function that returns newly constructed sound node that has been added to provided SoundCue's Node Graph. | SoundCueTemplate.h | |
static T & ConstructSoundNodeRoot
(
USoundCue& SoundCue |
Constructs initial root sound node of template. | SoundCueTemplate.h | |
static float GetInitialHeightOffset() |
Initial height offset of first node in the SoundCueEditor. | SoundCueTemplate.h | |
static float GetInitialWidthOffset() |
Initial width offset of first node in the SoundCueEditor. | SoundCueTemplate.h | |
static float GetNodeHeightOffset() |
Node height offset between nodes in the SoundCueEditor. | SoundCueTemplate.h | |
static float GetNodeWidthOffset() |
Node width offset between nodes in the SoundCueEditor. | SoundCueTemplate.h | |
static void SetSoundNodePosition
(
USoundNode& InNode, |
Sets the provided node's position to the location on the template's grid | SoundCueTemplate.h |