Navigation
API > API/Plugins > API/Plugins/SoundScape
| Name | UActiveSoundscapeColor |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Soundscape/Source/SoundScape/Public/SoundscapeColor.h |
| Include Path | #include "SoundscapeColor.h" |
Syntax
UCLASS (BlueprintType, ClassGroup=Soundscape)
class UActiveSoundscapeColor : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActiveSoundscapeColor
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FadeInMin | float | SoundscapeColor.h | ||
| FadeOutMin | float | Playback stop values. | SoundscapeColor.h | |
| PitchMod | float | SoundscapeColor.h | ||
| SoundscapeParameterChangeDelegate | FScriptDelegate | Delegates for parameter change bindings. | SoundscapeColor.h | |
| UpdateTimer | FTimerHandle | Timer delegate for amortized updates. | SoundscapeColor.h | |
| VolumeMod | float | Playback start values. | SoundscapeColor.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFirstSpawn | bool | First Spawn. | SoundscapeColor.h | |
| bIsPlaying | bool | Is Playing Bool. | SoundscapeColor.h | |
| bTracing | bool | Currently mid trace. | SoundscapeColor.h | |
| bVoiceInPoolFree | bool | Voice in pool is free. | SoundscapeColor.h | |
| ModulationBehavior | FSoundscapeColorModulationSettings | Modulation behavior. | SoundscapeColor.h | |
| NewSoundParams | FSoundscapeColorVoiceParams | Last calculated color voice parameters. | SoundscapeColor.h | |
| PitchBase | float | Base Pitch Scalar. | SoundscapeColor.h | |
| PlaybackBehavior | FSoundscapeColorPlaybackSettings | Playback behavior. | SoundscapeColor.h | |
| Sound | TObjectPtr< USoundBase > | Sound to Play. | SoundscapeColor.h | |
| SoundscapeColorVoicePool | TArray< TObjectPtr< UActiveSoundscapeColorVoice > > | Audio Component Pool. | SoundscapeColor.h | |
| SpawnBehavior | FSoundscapeColorSpawnSettings | Playback behavior. | SoundscapeColor.h | |
| VolumeBase | float | Base Volume Scalar. | SoundscapeColor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BindToParameterChangeDelegate
(
USoundscapeColor* SoundscapeColor |
Functionality related to Settings parameter changes to feed changes in preset Asset to instances of Active Soundscape Colors. | SoundscapeColor.h | |
bool IsPlaying() |
Is playing. | SoundscapeColor.h |
|
void OnSoundscapeColorParameterChange
(
const USoundscapeColor* SoundscapeColor |
Function bound to the Parameter change delegate. | SoundscapeColor.h | |
void Play
(
float ColorVolume, |
Play Active Soundscape Color. | SoundscapeColor.h |
|
void PlayNative() |
Native play function. | SoundscapeColor.h | |
void SetParameterValues
(
const USoundscapeColor* SoundscapeColor |
Initializes parameters based on SoundscapeColor settings. | SoundscapeColor.h | |
void Stop
(
float ColorFadeOutTime |
Stop Active Soundscape Color. | SoundscapeColor.h |
|
void StopNative() |
Native stop function. | SoundscapeColor.h | |
void UpdateSoundscapeColor() |
Timer Update Call. | SoundscapeColor.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
SoundscapeColor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnTraceCompleted
(
const FTraceHandle& Handle, |
Function called on completion of trace. | SoundscapeColor.h | |
FTraceHandle SpawnSoundByTrace() |
Call an async trace. | SoundscapeColor.h |