unreal.AttenuationVolumeComponent

class unreal.AttenuationVolumeComponent(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: AudioGameplayVolumeMutator

UAttenuationVolumeComponent - Audio Gameplay Volume component for occlusion settings (volume attenuation)

C++ Source:

  • Plugin: AudioGameplayVolume

  • Module: AudioGameplayVolume

  • File: AttenuationVolumeComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • exterior_time (float): [Read-Write] Exterior Time: The time over which to interpolate from the current volume to the desired volume of sounds outside the volume when the player enters the volume

  • exterior_volume (float): [Read-Write] Exterior Volume: The desired volume of sounds outside the volume when the player is inside the volume

  • interior_time (float): [Read-Write] Interior Time: The time over which to interpolate from the current volume to the desired volume of sounds inside the volume when the player enters the volume

  • interior_volume (float): [Read-Write] Interior Volume: The desired volume of sounds inside the volume when the player is outside the volume

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • priority (int32): [Read-Write] Priority: The priority of this component. In the case of overlapping volumes or multiple affecting components, the highest priority is chosen.

  • replicate_using_registered_sub_object_list (bool): [Read-Write] Replicate Using Registered Sub Object List: When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property exterior_time: float

[Read-Only] Exterior Time: The time over which to interpolate from the current volume to the desired volume of sounds outside the volume when the player enters the volume

Type:

(float)

property exterior_volume: float

[Read-Only] Exterior Volume: The desired volume of sounds outside the volume when the player is inside the volume

Type:

(float)

property interior_time: float

[Read-Only] Interior Time: The time over which to interpolate from the current volume to the desired volume of sounds inside the volume when the player enters the volume

Type:

(float)

property interior_volume: float

[Read-Only] Interior Volume: The desired volume of sounds inside the volume when the player is outside the volume

Type:

(float)

set_exterior_volume(volume, interpolate_time) → None

Set Exterior Volume

Parameters:
set_interior_volume(volume, interpolate_time) → None

Set Interior Volume

Parameters: