UAudioComponent::CollectAttenuationShapesForVisualization

function Engine Since unknown

#include "Components/AudioComponent.h"

Access: public Specifiers: const

Description

Gathers the attenuation shapes applicable to this component's sound into a multimap, keyed by shape type, for editor or in-game debug visualization.

Caveats & Gotchas

• Intended for editor gizmo drawing and debug visualization (e.g. "Show Sound Radius") — not something gameplay code typically needs to call.
• Not a UFUNCTION; there's no Blueprint access to this data.

Signature

void CollectAttenuationShapesForVisualization(TMultiMap<EAttenuationShape::Type, FBaseAttenuationSettings::AttenuationShapeDetails>& ShapeDetailsMap) const

Parameters

Name	Type	Description	Default
ShapeDetailsMap	TMultiMap<EAttenuationShape::Type, FBaseAttenuationSettings::AttenuationShapeDetails>&	Populated with the attenuation shapes (sphere, box, cone, capsule) applicable to this component's sound, keyed by shape type.	—

Return Type

void

Example

Collecting shapes for debug drawing C++

TMultiMap<EAttenuationShape::Type, FBaseAttenuationSettings::AttenuationShapeDetails> ShapeDetails;
AudioComponent->CollectAttenuationShapesForVisualization(ShapeDetails);
// Iterate ShapeDetails to draw debug spheres/boxes/cones for each attenuation shape

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?