unreal.SoundscapeSubsystem

class unreal.SoundscapeSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: GameInstanceSubsystem

Soundscape Subsystem

C++ Source:

• Plugin: Soundscape

• Module: Soundscape

• File: SoundscapeSubsystem.h

add_color_point_collection(color_point_collection_name, color_point_collection) → None

Add a Color Point Collection to the Subsystem, returns true if successful

Parameters:

• color_point_collection_name (Name) –

• color_point_collection (SoundscapeColorPointCollection) –

add_palette_collection(palette_collection_name, palette_collection) → bool

Add Palette Collection

Parameters:

• palette_collection_name (Name) –

• palette_collection (SoundscapePaletteCollection) –

Return type:

bool

check_color_point_density(location, color_point) → int32

Check Color Point Density for a Location Cell

Parameters:

• location (Vector) –

• color_point (GameplayTag) –

Return type:

int32

clear_state(soundscape_state) → None

Clear State

Parameters:

soundscape_state (GameplayTag) –

remove_color_point_collection(color_point_collection_name) → bool

Remove a Color Point Collection from the Subsystem, returns true if successful

Parameters:

color_point_collection_name (Name) –

Return type:

bool

remove_palette_collection(palette_collection_name) → bool

Remove Palette Collection

Parameters:

palette_collection_name (Name) –

Return type:

bool

restart_soundscape() → None

Restart Soundscape

set_state(soundscape_state) → None

Set State

Parameters:

soundscape_state (GameplayTag) –