Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
|
Module |
|
|
Header |
/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioPlayer.h |
|
Include |
#include "NiagaraDataInterfaceAudioPlayer.h" |
UCLASS(EditInlineNew, Category="Audio", Meta=(DisplayName="Audio Player"))
class UNiagaraDataInterfaceAudioPlayer : public UNiagaraDataInterface
This Data Interface can be used to play one-shot audio effects driven by particle data.
| Name | Description | ||
|---|---|---|---|
|
|
TObjectPtr< USo... |
Attenuation |
Optional sound attenuation setting to use |
|
|
bLimitPlaysPerTick |
||
|
|
bOnlyActiveDuringGameplay |
If true then this data interface only processes sounds during active gameplay. |
|
|
|
bStopWhenComponentIsDestroyed |
If false then it the audio component keeps playing after the niagara component was destroyed. |
|
|
|
TObjectPtr< USo... |
Concurrency |
Optional sound concurrency setting to use |
|
|
MaxPlaysPerTick |
This sets the max number of sounds played each tick. |
|
|
|
ParameterNames |
A set of parameter names that can be referenced via index when setting sound cue parameters on persistent audio |
|
|
|
TObjectPtr< USo... |
SoundToPlay |
Reference to the audio asset to play |
| Name | Description | |
|---|---|---|
|
|
UNiagaraDataInterfaceAudioPlayer ( |
| Name | Description | ||
|---|---|---|---|
|
|
CanExecuteOnTarget ( |
||
|
|
CopyToInternal ( |
||
|
|
DestroyPerInstanceData ( |
Destroys the per instance data for this interface. |
|
|
|
Equals ( |
Determines if this DataInterface is the same as another. |
|
|
|
GetFunctions ( |
Gets all the available functions for this data interface. |
|
|
|
GetVMExternalFunction ( |
Returns the delegate for the passed function signature. |
|
|
|
HasPostSimulateTick() |
||
|
|
HasPreSimulateTick() |
||
|
|
InitPerInstanceData ( |
Initializes the per instance data for this interface. |
|
|
|
PerInstanceDataSize() |
Returns the size of the per instance data for this interface. |
|
|
|
PerInstanceTick ( |
Ticks the per instance data for this interface, if it has any. |
|
|
|
PerInstanceTickPostSimulate ( |
||
|
|
PostSimulateCanOverlapFrames() |
When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread. |
|
|
|
UpgradeFunctionCall ( |
Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. |
| Name | Description | ||
|---|---|---|---|
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |