unreal.AudioGameplayVolumeProxyComponent

class unreal.AudioGameplayVolumeProxyComponent(outer=None, name='None')

Bases: unreal.AudioGameplayComponent

UAudioGameplayVolumeProxyComponent - Component used to drive interaction with AudioGameplayVolumeSubsystem.

NOTE: Do not inherit from this class, use UAudioGameplayVolumeComponentBase to create extendable functionality

C++ Source:

  • Plugin: AudioGameplayVolume

  • Module: AudioGameplayVolume

  • File: AudioGameplayVolumeComponent.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

  • 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

  • on_proxy_enter (OnAudioGameplayVolumeProxyStateChange): [Read-Write] On Proxy Enter: Blueprint event for proxy enter

  • on_proxy_exit (OnAudioGameplayVolumeProxyStateChange): [Read-Write] On Proxy Exit: Blueprint event for proxy exit

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

  • proxy (AudioGameplayVolumeProxy): [Read-Write] Proxy: A representation of this volume for the audio thread

  • 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 on_proxy_enter

[Read-Write] On Proxy Enter: Blueprint event for proxy enter

Type

(OnAudioGameplayVolumeProxyStateChange)

property on_proxy_exit

[Read-Write] On Proxy Exit: Blueprint event for proxy exit

Type

(OnAudioGameplayVolumeProxyStateChange)

property proxy

[Read-Write] Proxy: A representation of this volume for the audio thread

Type

(AudioGameplayVolumeProxy)