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.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

SoundCueTemplates

Header

/Engine/Plugins/Runtime/SoundCueTemplates/Source/SoundCueTemplates/Public/SoundCueTemplate.h

Include

#include "SoundCueTemplate.h"

Syntax

UCLASS(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

Public function

USoundCueTemplate

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function Static

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.

Public function Virtual

void

 

AddSoundWaves

(
    TArray< TWeakObjectPtr< USoundWave ...
)

Override to initialize a template with array of sound waves from SoundCueFactory

Protected function Static

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.

Protected function Static

T &

 

ConstructSoundNodeRoot

(
    USoundCue& SoundCue
)

Constructs initial root sound node of template.

Protected function Static

float

 

GetInitialHeightOffset()

Initial height offset of first node in the SoundCueEditor.

Protected function Static

float

 

GetInitialWidthOffset()

Initial width offset of first node in the SoundCueEditor.

Protected function Static

float

 

GetNodeHeightOffset()

Node height offset between nodes in the SoundCueEditor.

Protected function Static

float

 

GetNodeWidthOffset()

Node width offset between nodes in the SoundCueEditor.

Protected function Virtual Const

void

 

OnRebuildGraph

(
    USoundCue& SoundCue
)

Function to override that uses internal editor-data only properties to re-build node graph of provided SoundCue.

Public function Const

void

 

RebuildGraph

(
    USoundCue& SoundCue
)

Rebuilds the graph when user-facing properties are changed

Protected function Static

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

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally