unreal.BaseAttenuationSettings

class unreal.BaseAttenuationSettings(distance_algorithm: AttenuationDistanceModel = Ellipsis, attenuation_shape: AttenuationShape = Ellipsis, falloff_mode: NaturalSoundFalloffMode = Ellipsis, d_b_attenuation_at_max: float = 0.0, attenuation_shape_extents: Vector = Ellipsis, cone_offset: float = 0.0, falloff_distance: float = 0.0, cone_sphere_radius: float = 0.0, cone_sphere_falloff_distance: float = 0.0, custom_attenuation_curve: RuntimeFloatCurve = [])

Bases: StructBase

• Base class for attenuation settings.

C++ Source:

• Module: Engine

• File: Attenuation.h

Editor Properties: (see get_editor_property/set_editor_property)

• attenuation_shape (AttenuationShape): [Read-Write] The shape of the non-custom attenuation method.

• attenuation_shape_extents (Vector): [Read-Write] The dimensions to use for the attenuation shape. Interpretation of the values differ per shape.

  Sphere - X is Sphere Radius. Y and Z are unused Capsule - X is Capsule Half Height, Y is Capsule Radius, Z is unused Box - X, Y, and Z are the Box’s dimensions Cone - X is Cone Radius, Y is Cone Angle, Z is Cone Falloff Angle

• cone_offset (float): [Read-Write] The distance back from the sound’s origin to begin the cone when using the cone attenuation shape.

• cone_sphere_falloff_distance (float): [Read-Write] The distance over which volume attenuation occurs for the optional sphere shape.

• cone_sphere_radius (float): [Read-Write] An optional attenuation radius (sphere) that extends from the cone origin.

• custom_attenuation_curve (RuntimeFloatCurve): [Read-Write] The custom volume attenuation curve to use.

• d_b_attenuation_at_max (float): [Read-Write] The attenuation volume at the falloff distance in decibels (Only for ‘Natural Sound’ Distance Algorithm).

• distance_algorithm (AttenuationDistanceModel): [Read-Write] The type of attenuation as a function of distance to use.

• falloff_distance (float): [Read-Write] The distance over which volume attenuation occurs.

• falloff_mode (NaturalSoundFalloffMode): [Read-Write] Whether to continue attenuating, go silent, or hold last volume value when beyond falloff bounds and ‘Attenuation At Max (dB)’ is set to a value greater than -60dB. (Only for ‘Natural Sound’ Distance Algorithm). */

property attenuation_shape: AttenuationShape

[Read-Write] The shape of the non-custom attenuation method.

Type:

(AttenuationShape)

property attenuation_shape_extents: Vector

[Read-Write] The dimensions to use for the attenuation shape. Interpretation of the values differ per shape. Sphere - X is Sphere Radius. Y and Z are unused Capsule - X is Capsule Half Height, Y is Capsule Radius, Z is unused Box - X, Y, and Z are the Box’s dimensions Cone - X is Cone Radius, Y is Cone Angle, Z is Cone Falloff Angle

Type:

(Vector)

property cone_offset: float

[Read-Write] The distance back from the sound’s origin to begin the cone when using the cone attenuation shape.

Type:

(float)

property cone_sphere_falloff_distance: float

[Read-Write] The distance over which volume attenuation occurs for the optional sphere shape.

Type:

(float)

property cone_sphere_radius: float

[Read-Write] An optional attenuation radius (sphere) that extends from the cone origin.

Type:

(float)

property custom_attenuation_curve: RuntimeFloatCurve

[Read-Write] The custom volume attenuation curve to use.

Type:

(RuntimeFloatCurve)

property d_b_attenuation_at_max: float

[Read-Write] The attenuation volume at the falloff distance in decibels (Only for ‘Natural Sound’ Distance Algorithm).

Type:

(float)

property distance_algorithm: AttenuationDistanceModel

[Read-Write] The type of attenuation as a function of distance to use.

Type:

(AttenuationDistanceModel)

property falloff_distance: float

[Read-Write] The distance over which volume attenuation occurs.

Type:

(float)

property falloff_mode: NaturalSoundFalloffMode

[Read-Write] Whether to continue attenuating, go silent, or hold last volume value when beyond falloff bounds and ‘Attenuation At Max (dB)’ is set to a value greater than -60dB. (Only for ‘Natural Sound’ Distance Algorithm). */

Type:

(NaturalSoundFalloffMode)