unreal.SoundClass

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

Bases: Object

Sound Class

C++ Source:

  • Module: Engine

  • File: SoundClass.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

  • child_classes (Array[SoundClass]): [Read-Write]

  • parent_class (SoundClass): [Read-Write]

  • passive_sound_mix_modifiers (Array[PassiveSoundMixModifier]): [Read-Write] SoundMix Modifiers to activate automatically when a sound of this class is playing.

  • properties (SoundClassProperties): [Read-Write] Configurable properties like volume and priority.

add_asset_user_data_of_class(user_data_class) bool

Creates and adds an instance of the provided AssetUserData class to the target asset.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to create

Returns:

Whether or not an instance of InUserDataClass was succesfully added

Return type:

bool

property child_classes: None

[Read-Only]

Type:

(Array[SoundClass])

get_asset_user_data_of_class(user_data_class) AssetUserData

Returns an instance of the provided AssetUserData class if it’s contained in the target asset.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to get

Returns:

The instance of the UAssetUserData class contained, or null if it doesn’t exist

Return type:

AssetUserData

has_asset_user_data_of_class(user_data_class) bool

Checks whether or not an instance of the provided AssetUserData class is contained.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to check for

Returns:

Whether or not an instance of InUserDataClass was found

Return type:

bool

property parent_class: SoundClass

[Read-Only]

Type:

(SoundClass)

property passive_sound_mix_modifiers: None

[Read-Only] SoundMix Modifiers to activate automatically when a sound of this class is playing.

Type:

(Array[PassiveSoundMixModifier])

property properties: SoundClassProperties

[Read-Only] Configurable properties like volume and priority.

Type:

(SoundClassProperties)