1. Epic GamesDeveloper
  3. USoundscapeSubsystem

USoundscapeSubsystem

API > API/Plugins > API/Plugins/SoundScape

   
Name USoundscapeSubsystem
Type class
Header File /Engine/Plugins/Runtime/Soundscape/Source/SoundScape/Public/SoundscapeSubsystem.h
Include Path #include "SoundscapeSubsystem.h"

Syntax

UCLASS ()  
class USoundscapeSubsystem : public UGameInstanceSubsystem

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDebugMode bool   SoundscapeSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveAssetLoadHandles TMap< FName, TSharedPtr< FStreamableHandle > >   SoundscapeSubsystem.h  
ActiveColorPointCollection FSoundscapeColorPointCollection Active Color Point Collection. SoundscapeSubsystem.h  
ActiveColorPointHashMap TObjectPtr< USoundscapeColorPointHashMap >   SoundscapeSubsystem.h  
ActiveColorPointHashUpdateTimeSeconds float Hash Cell Update Timing for the Active Hash. SoundscapeSubsystem.h  
ActiveColorPointHashWidth float Hash Cell Width for the Active Hash. SoundscapeSubsystem.h  
ActiveColorPointUpdateTimer FTimerHandle Timer delegate for amortized updates. SoundscapeSubsystem.h  
ActivePalettes TMap< TObjectPtr< USoundscapePalette >, TObjectPtr< UActiveSoundscapePalette > >   SoundscapeSubsystem.h  
ActiveSoundscapeColorPointComponents TArray< const USoundscapeColorPointComponent * > Active Color Point Components. SoundscapeSubsystem.h  
AudioDeviceID Audio::FDeviceId   SoundscapeSubsystem.h  
ColorPointCollections TMap< FName, FSoundscapeColorPointCollection > Stored Color Point Collections. SoundscapeSubsystem.h  
ColorPointHashMapCollections TArray< TObjectPtr< USoundscapeColorPointHashMapCollection > > Stored Hash Map Collections. SoundscapeSubsystem.h
  • Transient
ColorPointHashMapLOD1 TObjectPtr< USoundscapeColorPointHashMap > Color Point Hash Maps. SoundscapeSubsystem.h  
ColorPointHashMapLOD2 TObjectPtr< USoundscapeColorPointHashMap >   SoundscapeSubsystem.h  
ColorPointHashMapLOD3 TObjectPtr< USoundscapeColorPointHashMap >   SoundscapeSubsystem.h  
LoadedPaletteCollectionSet TSet< TObjectPtr< USoundscapePalette > >   SoundscapeSubsystem.h  
LOD1ColorPointHashDistance float Hash Cell LOD1 Max Distance. SoundscapeSubsystem.h  
LOD1ColorPointHashWidth float Hash Cell Width for LOD1. SoundscapeSubsystem.h  
LOD2ColorPointHashDistance float Hash Cell LOD2 Max Distance. SoundscapeSubsystem.h  
LOD2ColorPointHashWidth float Hash Cell Width for LOD2. SoundscapeSubsystem.h  
LOD3ColorPointHashWidth float Hash Cell Width for LOD3. SoundscapeSubsystem.h  
SubsystemState FGameplayTagContainer   SoundscapeSubsystem.h  
UnloadedPaletteCollections TMap< FName, FSoundscapePaletteCollection >   SoundscapeSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddActiveColorPoint ( const USoundscapeColorPointComponent* SoundscapeColorPointComponent
)

 Add Active Color Point. SoundscapeSubsystem.h  

void AddColorPointCollection ( FName ColorPointCollectionName,
FSoundscapeColorPointCollection ColorPointCollection
)

 Soundscape Color Point system. SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

void AddColorPointHashMapCollection ( USoundscapeColorPointHashMapCollection* ColorPointHashMapCollection
)

 Add Hash Map Collection. SoundscapeSubsystem.h  

bool AddPaletteCollection ( FName PaletteCollectionName,
FSoundscapePaletteCollection PaletteCollection
)

   SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

TPair< FVector, FVector > CalculateDebugCellDimensions ( FVector Location,
ESoundscapeLOD SoundscapeLOD
)

 Calculate Debug Cell Dimensions. SoundscapeSubsystem.h  

int32 CheckColorPointDensity ( FVector Location,
FGameplayTag ColorPoint
)

 Check Color Point Density for a Location Cell. SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

void ClearState ( FGameplayTag SoundscapeState
)

   SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

virtual void Deinitialize()

   SoundscapeSubsystem.h  

void DrawDebugCell ( FVector Location,
bool bSuccess
)

 Draw Debug Cell. SoundscapeSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 Begin USubsystem. SoundscapeSubsystem.h  

void RemoveActiveColorPoint ( const USoundscapeColorPointComponent* SoundscapeColorPointComponent
)

 Remove Active Color Point. SoundscapeSubsystem.h  

bool RemoveColorPointCollection ( FName ColorPointCollectionName
)

 Remove a Color Point Collection from the Subsystem, returns true if successful. SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

bool RemoveColorPointHashMapCollection ( USoundscapeColorPointHashMapCollection* ColorPointHashMapCollection
)

 Add Hash Map Collection. SoundscapeSubsystem.h  

bool RemovePaletteCollection ( FName PaletteCollectionName
)

   SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

void RestartSoundscape()

   SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

void SetState ( FGameplayTag SoundscapeState
)

 Settings. SoundscapeSubsystem.h
  • BlueprintCallable
  • Category="Soundscape"

virtual bool ShouldCreateSubsystem ( UObject* Outer
) const

   SoundscapeSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page