Navigation
API > API/Plugins > API/Plugins/SoundScape
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActiveSoundscapeColor
References
| Module | SoundScape |
| Header | /Engine/Plugins/Runtime/Soundscape/Source/SoundScape/Public/SoundscapeColor.h |
| Include | #include "SoundscapeColor.h" |
Syntax
UCLASS&40;BlueprintType, ClassGroup&61;Soundscape&41;
class UActiveSoundscapeColor : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
| float | FadeInMin | ||
| float | FadeOutMin | Playback stop values. | |
| float | PitchMod | ||
| FScriptDelegate | SoundscapeParameterChangeDelegate | Delegates for parameter change bindings. | |
| FTraceDelegate | TraceDelegate | ||
| FTraceHandle | TraceHandle | ||
| FTimerHandle | UpdateTimer | Timer delegate for amortized updates. | |
| float | VolumeMod | Playback start values. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BindToParameterChangeDelegate
(
USoundscapeColor* SoundscapeColor |
Functionality related to Settings parameter changes to feed changes in preset Asset to instances of Active Soundscape Colors. | |
| bool | IsPlaying () |
Is playing. | |
| void | OnSoundscapeColorParameterChange
(
const USoundscapeColor* SoundscapeColor |
Function bound to the Parameter change delegate. | |
| void | OnTraceCompleted
(
const FTraceHandle& Handle, |
Function called on completion of trace. | |
| void | Play
(
float ColorVolume, |
Play Active Soundscape Color. | |
| void | PlayNative () |
Native play function. | |
| void | SetParameterValues
(
const USoundscapeColor* SoundscapeColor |
Initializes parameters based on SoundscapeColor settings. | |
| FTraceHandle | Call an async trace. | ||
| void | Stop
(
float ColorFadeOutTime |
Stop Active Soundscape Color. | |
| void | StopNative () |
Native stop function. | |
| void | Timer Update Call. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. |