Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
Wrapper for FVariant, an extensible union of multiple types
exposed to blueprints as a "Type Parameter", which in blueprints:
- allows the user to select the type the parameter represents
- assign the value for the type
We can then retrieve the underlying value by checking what type is stored and reading the value accordingly
Serializes as an FVariant, which serializes the value as a byte array.
| Name | FTypedParameter |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Containers/TypedParameter.h |
| Include Path | #include "HarmonixDsp/Containers/TypedParameter.h" |
Syntax
USTRUCT ()
struct FTypedParameter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default to int type | HarmonixDsp/Containers/TypedParameter.h | ||
FTypedParameter
(
T InValue |
HarmonixDsp/Containers/TypedParameter.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| kVersion | const uint8 | HarmonixDsp/Containers/TypedParameter.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Value | FVariant | HarmonixDsp/Containers/TypedParameter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EParameterType GetType() |
Gets the type this parameter represents | HarmonixDsp/Containers/TypedParameter.h | |
T GetValue() |
Template method for getting the stored value asserts that value type is valid and matches | HarmonixDsp/Containers/TypedParameter.h | |
bool IsType () |
Template method to check type matches | HarmonixDsp/Containers/TypedParameter.h | |
bool IsType
(
EParameterType InType |
Same as this->GetType() == InType; | HarmonixDsp/Containers/TypedParameter.h | |
bool Serialize
(
FArchive& Ar |
Custom struct serialization | HarmonixDsp/Containers/TypedParameter.h | |
void SetType () |
HarmonixDsp/Containers/TypedParameter.h | ||
void SetType
(
EParameterType Type |
Set the type this Parameter represents will reset the value to the default for the type only if the type is different | HarmonixDsp/Containers/TypedParameter.h | |
void SetValue
(
T InValue |
Template method for setting the stored value asserts that the value type is supported | HarmonixDsp/Containers/TypedParameter.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool FindMappedValue
(
const TMap< FName, FTypedParameter >& ParameterMap, |
HarmonixDsp/Containers/TypedParameter.h | ||
static EParameterType FromVariantType
(
EVariantTypes VariantType |
HarmonixDsp/Containers/TypedParameter.h |