Navigation
API > API/Runtime > API/Runtime/SlateCore
An intermediary to make UBaseSound available for Slate to play sounds
| Name | FSlateSound |
| Type | struct |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Sound/SlateSound.h |
| Include Path | #include "Sound/SlateSound.h" |
Syntax
USTRUCT (BlueprintType )
struct FSlateSound
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateSound () |
Default constructor. | Sound/SlateSound.h | |
FSlateSound
(
const FSlateSound& |
Default copy constructor. | Sound/SlateSound.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UObject * GetResourceObject () |
Get the resource object associated with this sound | Sound/SlateSound.h | |
bool SerializeFromMismatchedTag
(
FPropertyTag const& Tag, |
Used to upgrade a FName property to a FSlateSound property | Sound/SlateSound.h | |
void SetResourceObject
(
UObject* InResourceObject |
Sets the sound that is supposed to be played. | Sound/SlateSound.h |
Static
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateSound & operator=
(
const FSlateSound& |
Default copy-assignment operator. | Sound/SlateSound.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LegacyResourceName_DEPRECATED | FName | The legacy resource name; only used by sounds that have been set-up in code, or otherwise upgraded from old FName properties, set to NAME_None in non-legacy instances | Sound/SlateSound.h | |
| LegacyResourceObject_DEPRECATED | TWeakObjectPtr< UObject > | A weak pointer the the resource loaded from the legacy resource name; may be null if the resource needs (re)loading | Sound/SlateSound.h |
Deprecated Functions
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSlateSound FromName_DEPRECATED
(
const FName& SoundName |
Construct a FSlateSound from a FName | Sound/SlateSound.h | |
void StripLegacyData_DEPRECATED() |
Used when updating the ResourceObject within an FSlateSound from the editor to clear out any legacy data that may be set. | Sound/SlateSound.h |