UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
USoundCue Class Reference

#include <SoundCue.h>

+ Inheritance diagram for USoundCue:

Public Member Functions

virtual ENGINE_API FString GetDesc () override
 
virtual ENGINE_API void PostLoad () override
 
virtual ENGINE_API void Serialize (FStructuredArchive::FRecord Record) override
 
virtual ENGINE_API bool CanBeClusterRoot () const override
 
virtual ENGINE_API bool CanBeInCluster () const override
 
virtual ENGINE_API void BeginDestroy () override
 
virtual ENGINE_API bool IsPlayable () const override
 
virtual ENGINE_API bool IsPlayWhenSilent () const override
 
virtual ENGINE_API bool ShouldApplyInteriorVolumes () override
 
virtual ENGINE_API void Parse (class FAudioDevice *AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound &ActiveSound, const FSoundParseParameters &ParseParams, TArray< FWaveInstance * > &WaveInstances) override
 
virtual ENGINE_API float GetVolumeMultiplier () override
 
virtual ENGINE_API float GetPitchMultiplier () override
 
virtual ENGINE_API float GetMaxDistance () const override
 
virtual ENGINE_API float GetDuration () const override
 
virtual ENGINE_API const FSoundAttenuationSettingsGetAttenuationSettingsToApply () const override
 
virtual ENGINE_API float GetSubtitlePriority () const override
 
virtual ENGINE_API bool GetSoundWavesWithCookedAnalysisData (TArray< USoundWave * > &OutSoundWaves) override
 
virtual ENGINE_API bool HasCookedFFTData () const override
 
virtual ENGINE_API bool HasCookedAmplitudeEnvelopeData () const override
 
virtual ENGINE_API TSharedPtr< Audio::IParameterTransmitterCreateParameterTransmitter (Audio::FParameterTransmitterInitParams &&InParams) const override
 
virtual bool IsAttenuationSettingsEditable () const override
 
template<class T >
T * ConstructSoundNode (TSubclassOf< USoundNode > SoundNodeClass=T::StaticClass(), bool bSelectNewNode=true)
 
virtual ENGINE_API int32 GetResourceSizeForFormat (FName Format)
 
ENGINE_API void RecursiveFindAllNodes (USoundNode *Node, TArray< USoundNode * > &OutNodes)
 
template<typename T >
void RecursiveFindNode (USoundNode *Node, TArray< T * > &OutNodes)
 
template<typename T >
void RecursiveFindNode (const USoundNode *Node, TArray< const T * > &OutNodes) const
 
ENGINE_API bool FindPathToNode (const UPTRINT NodeHashToFind, TArray< USoundNode * > &OutPath) const
 
int32 GetCookedQualityIndex () const
 
ENGINE_API void CacheAggregateValues ()
 
ENGINE_API void PrimeSoundCue ()
 
ENGINE_API void RetainSoundCue ()
 
ENGINE_API void ReleaseRetainedAudio ()
 
ENGINE_API void CacheLoadingBehavior (ESoundWaveLoadingBehavior InBehavior)
 
ENGINE_API void RecursiveFindAttenuation (USoundNode *Node, TArray< USoundNodeAttenuation * > &OutNodes)
 
ENGINE_API void RecursiveFindAttenuation (const USoundNode *Node, TArray< const USoundNodeAttenuation * > &OutNodes) const
 
ENGINE_API float EvaluateMaxAttenuation (const FTransform &Origin, FVector Location, float DistanceScale=1.f) const
 
- Public Member Functions inherited from USoundBase
virtual ENGINE_API void PreSave (FObjectPreSaveContext SaveContext) override
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API bool SupportsSubtitles () const
 
virtual ENGINE_API bool HasAttenuationNode () const
 
ENGINE_API bool HasDelayNode () const
 
ENGINE_API bool HasConcatenatorNode () const
 
virtual class UCurveTableGetCurveData () const
 
virtual ENGINE_API bool IsLooping () const
 
virtual ENGINE_API bool IsOneShot () const
 
virtual bool IsProcedurallyGenerated () const
 
virtual ENGINE_API USoundClassGetSoundClass () const
 
virtual ENGINE_API USoundSubmixBaseGetSoundSubmix () const
 
ENGINE_API void GetSoundSubmixSends (TArray< FSoundSubmixSendInfo > &OutSends) const
 
ENGINE_API void GetSoundSourceBusSends (EBusSendType BusSendType, TArray< FSoundSourceBusSendInfo > &OutSends) const
 
ENGINE_API void GetConcurrencyHandles (TArray< FConcurrencyHandle > &OutConcurrencyHandles) const
 
ENGINE_API float GetPriority () const
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
virtual ENGINE_API void InitParameters (TArray< FAudioParameter > &ParametersToInit, FName InFeatureName=NAME_None)
 
virtual void InitResources ()
 
virtual bool ImplementsParameterInterface (Audio::FParameterInterfacePtr InParameterInterface) const
 
virtual ISoundGeneratorPtr CreateSoundGenerator (const FSoundGeneratorInitParams &InParams)
 
virtual ISoundGeneratorPtr CreateSoundGenerator (const FSoundGeneratorInitParams &InParams, TArray< FAudioParameter > &&InDefaultParameters)
 
virtual ENGINE_API bool IsParameterValid (const FAudioParameter &InParameter) const
 
virtual bool GetAllDefaultParameters (TArray< FAudioParameter > &OutParameters) const
 
 UE_DEPRECATED (5.7, "This is no longer used.") virtual bool EnableSubmixSendsOnPreview() const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static ENGINE_API void StaticAudioQualityChanged (int32 NewQualityLevel)
 
static int32 GetCachedQualityLevel ()
 
static ENGINE_API void CacheQualityLevel ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

uint8 bPrimeOnLoad: 1
 
uint8 bOverrideAttenuation: 1
 
uint8 bExcludeFromRandomNodeBranchCulling: 1
 
- Public Attributes inherited from USoundBase
TObjectPtr< USoundClassSoundClassObject
 
uint8 bDebug: 1
 
uint8 bOverrideConcurrency: 1
 
uint8 bEnableBusSends: 1
 
uint8 bEnableBaseSubmix: 1
 
uint8 bEnableSubmixSends: 1
 
uint8 bHasDelayNode: 1
 
uint8 bHasConcatenatorNode: 1
 
uint8 bBypassVolumeScaleForPriority: 1
 
EVirtualizationMode VirtualizationMode
 
TMap< Audio::FDeviceId, int32CurrentPlayCount
 
TSet< TObjectPtr< USoundConcurrency > > ConcurrencySet
 
FSoundConcurrencySettings ConcurrencyOverrides
 
float Duration
 
float MaxDistance
 
float TotalSamples
 
float Priority
 
TObjectPtr< USoundAttenuationAttenuationSettings
 
TObjectPtr< USoundSubmixBaseSoundSubmixObject
 
TArray< FSoundSubmixSendInfoSoundSubmixSends
 
TObjectPtr< USoundEffectSourcePresetChainSourceEffectChain
 
TArray< FSoundSourceBusSendInfoBusSends
 
TArray< FSoundSourceBusSendInfoPreEffectBusSends
 
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 

Protected Member Functions

ENGINE_API bool RecursiveFindPathToNode (USoundNode *CurrentNode, const UPTRINT CurrentHash, const UPTRINT NodeHashToFind, TArray< USoundNode * > &OutPath) const
 
ENGINE_API float ComputeMaxDistance () const override
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

float SubtitlePriority
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Detailed Description

The behavior of audio playback is defined within Sound Cues.

Member Function Documentation

◆ BeginDestroy()

void USoundCue::BeginDestroy ( )
overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UObject.

◆ CacheAggregateValues()

void USoundCue::CacheAggregateValues ( )

Call to cache any values which need to be computed from the sound cue graph. e.g. MaxDistance, Duration, etc.

◆ CacheLoadingBehavior()

void USoundCue::CacheLoadingBehavior ( ESoundWaveLoadingBehavior  InBehavior)

Call this when stream caching is enabled to update sound waves of loading behavior they are inheriting via SoundCue

◆ CacheQualityLevel()

void USoundCue::CacheQualityLevel ( )
static

◆ CanBeClusterRoot()

bool USoundCue::CanBeClusterRoot ( ) const
overridevirtual

Called after load to determine if the object can be a cluster root

Returns
true if this object can be a cluster root

Reimplemented from USoundBase.

◆ CanBeInCluster()

bool USoundCue::CanBeInCluster ( ) const
overridevirtual

Called during cluster construction if the object can be added to a cluster

Returns
true if this object can be inside of a cluster

Reimplemented from USoundBase.

◆ ComputeMaxDistance()

float USoundCue::ComputeMaxDistance ( ) const
overrideprotectedvirtual

Reimplemented from USoundBase.

◆ ConstructSoundNode()

template<class T >
T * USoundCue::ConstructSoundNode ( TSubclassOf< USoundNode SoundNodeClass = T::StaticClass(),
bool  bSelectNewNode = true 
)
inline

Construct and initialize a node within this Cue

◆ CreateParameterTransmitter()

TSharedPtr< Audio::IParameterTransmitter > USoundCue::CreateParameterTransmitter ( Audio::FParameterTransmitterInitParams &&  InParams) const
overridevirtual

Creates a parameter transmitter for communicating with active sound instances.

Reimplemented from USoundBase.

◆ EvaluateMaxAttenuation()

float USoundCue::EvaluateMaxAttenuation ( const FTransform Origin,
FVector  Location,
float  DistanceScale = 1.f 
) const

For SoundCues, use this instead of GetAttenuationSettingsToApply() -> Evaluate

In cases where a SoundCue has multiple Attenuation nodes within it, this function evaluates them all and returns the maximum value

Returns
float representing the max evaluated attenuation curve value based on distance from Origin to Location (will be 1.0 if no attenuation is set)

◆ FindPathToNode()

bool USoundCue::FindPathToNode ( const UPTRINT  NodeHashToFind,
TArray< USoundNode * > &  OutPath 
) const

Find the path through the sound cue to a node identified by its hash

◆ GetAttenuationSettingsToApply()

const FSoundAttenuationSettings * USoundCue::GetAttenuationSettingsToApply ( ) const
overridevirtual

Returns a pointer to the attenuation settings that are to be applied for this node

Reimplemented from USoundBase.

◆ GetCachedQualityLevel()

static int32 USoundCue::GetCachedQualityLevel ( )
inlinestatic

◆ GetCookedQualityIndex()

int32 USoundCue::GetCookedQualityIndex ( ) const
inline

Set the Quality level that the Cue was cooked at, called by the SoundQualityNodes

◆ GetDesc()

FString USoundCue::GetDesc ( void  )
overridevirtual

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Reimplemented from UObject.

◆ GetDuration()

float USoundCue::GetDuration ( ) const
overridevirtual

Returns the length of the sound

Reimplemented from USoundBase.

◆ GetMaxDistance()

float USoundCue::GetMaxDistance ( ) const
overridevirtual

Returns the farthest distance at which the sound could be heard

Reimplemented from USoundBase.

◆ GetPitchMultiplier()

float USoundCue::GetPitchMultiplier ( )
overridevirtual

Reimplemented from USoundBase.

◆ GetResourceSizeForFormat()

int32 USoundCue::GetResourceSizeForFormat ( FName  Format)
virtual
Parameters
FormatFormat to check
Returns
Sum of the size of waves referenced by this cue for the given platform.

◆ GetSoundWavesWithCookedAnalysisData()

bool USoundCue::GetSoundWavesWithCookedAnalysisData ( TArray< USoundWave * > &  OutSoundWaves)
overridevirtual

Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.

Reimplemented from USoundBase.

◆ GetSubtitlePriority()

float USoundCue::GetSubtitlePriority ( ) const
overridevirtual

Returns the subtitle priority

Reimplemented from USoundBase.

◆ GetVolumeMultiplier()

float USoundCue::GetVolumeMultiplier ( )
overridevirtual

Reimplemented from USoundBase.

◆ HasCookedAmplitudeEnvelopeData()

bool USoundCue::HasCookedAmplitudeEnvelopeData ( ) const
overridevirtual

Reimplemented from USoundBase.

◆ HasCookedFFTData()

bool USoundCue::HasCookedFFTData ( ) const
overridevirtual

Queries if the sound has cooked FFT or envelope data.

Reimplemented from USoundBase.

◆ IsAttenuationSettingsEditable()

virtual bool USoundCue::IsAttenuationSettingsEditable ( ) const
inlineoverridevirtual

Only used as an edit condition for AttenuationSettings member, as base classes may choose to provide an attenuation override implementation

Reimplemented from USoundBase.

◆ IsPlayable()

bool USoundCue::IsPlayable ( ) const
overridevirtual

Returns whether the sound base is set up in a playable manner

Reimplemented from USoundBase.

◆ IsPlayWhenSilent()

bool USoundCue::IsPlayWhenSilent ( ) const
overridevirtual

Returns true if any of the sounds in the sound have "play when silent" enabled.

Reimplemented from USoundBase.

◆ Parse()

void USoundCue::Parse ( class FAudioDevice AudioDevice,
const UPTRINT  NodeWaveInstanceHash,
FActiveSound ActiveSound,
const FSoundParseParameters ParseParams,
TArray< FWaveInstance * > &  WaveInstances 
)
overridevirtual

Parses the Sound to generate the WaveInstances to play.

Reimplemented from USoundBase.

◆ PostLoad()

void USoundCue::PostLoad ( )
overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UObject.

◆ PrimeSoundCue()

void USoundCue::PrimeSoundCue ( )

Call this when stream caching is enabled to prime all SoundWave assets referenced by this Sound Cue.

◆ RecursiveFindAllNodes()

void USoundCue::RecursiveFindAllNodes ( USoundNode Node,
TArray< USoundNode * > &  OutNodes 
)

Recursively finds all Nodes in the Tree

◆ RecursiveFindAttenuation() [1/2]

void USoundCue::RecursiveFindAttenuation ( const USoundNode Node,
TArray< const USoundNodeAttenuation * > &  OutNodes 
) const

◆ RecursiveFindAttenuation() [2/2]

void USoundCue::RecursiveFindAttenuation ( USoundNode Node,
TArray< USoundNodeAttenuation * > &  OutNodes 
)

◆ RecursiveFindNode() [1/2]

template<typename T >
void USoundCue::RecursiveFindNode ( const USoundNode Node,
TArray< const T * > &  OutNodes 
) const
inline

◆ RecursiveFindNode() [2/2]

template<typename T >
void USoundCue::RecursiveFindNode ( USoundNode Node,
TArray< T * > &  OutNodes 
)
inline

Recursively finds sound nodes of type T

◆ RecursiveFindPathToNode()

bool USoundCue::RecursiveFindPathToNode ( USoundNode CurrentNode,
const UPTRINT  CurrentHash,
const UPTRINT  NodeHashToFind,
TArray< USoundNode * > &  OutPath 
) const
protected

◆ ReleaseRetainedAudio()

void USoundCue::ReleaseRetainedAudio ( )

◆ RetainSoundCue()

void USoundCue::RetainSoundCue ( )

Call this when stream caching is enabled to retain all soundwave assets referenced by this sound cue.

◆ Serialize()

void USoundCue::Serialize ( FStructuredArchive::FRecord  Record)
overridevirtual

Reimplemented from UObject.

◆ ShouldApplyInteriorVolumes()

bool USoundCue::ShouldApplyInteriorVolumes ( )
overridevirtual

Returns whether or not any part of this sound wants interior volumes applied to it

Reimplemented from USoundBase.

◆ StaticAudioQualityChanged()

void USoundCue::StaticAudioQualityChanged ( int32  NewQualityLevel)
static

Call when the audio quality has been changed

Member Data Documentation

◆ bExcludeFromRandomNodeBranchCulling

uint8 USoundCue::bExcludeFromRandomNodeBranchCulling

◆ bOverrideAttenuation

uint8 USoundCue::bOverrideAttenuation

◆ bPrimeOnLoad

uint8 USoundCue::bPrimeOnLoad

◆ SubtitlePriority

float USoundCue::SubtitlePriority
protected

The documentation for this class was generated from the following files: