Version

menu_open
Wwise SDK 2019.1.11
ak.wwise.core.object.getAttenuationCurve

Gets the specified attenuation curve for a given attenuation object.

Arguments

Name Type Description
curveType * string Type of attenuation curve.
Possible values:
  • VolumeDryUsage
  • VolumeWetGameUsage
  • VolumeWetUserUsage
  • LowPassFilterUsage
  • HighPassFilterUsage
  • SpreadUsage
  • FocusUsage
platform string The ID (GUID) of the platform to get curves. Set to null-guid for unlinked reference.
object * any of: The ID (GUID), name, or path of attenuation object.
string The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.

(Required *)

Arguments Schema

Result

Name Type Description
curveType string Name of attenuation curve.
Possible values:
  • VolumeDryUsage
  • VolumeWetGameUsage
  • VolumeWetUserUsage
  • LowPassFilterUsage
  • HighPassFilterUsage
  • SpreadUsage
  • FocusUsage
use string Defines if the curve has no points, has its own set of points, or uses those of the VolumeDryUsage curve.
Possible values:
  • None
  • Custom
  • UseVolumeDry
points array An array of points for the attenuation curve.
points [...] object A point in the curve.
points[...].y * number Y coordinate of curve point.
points[...].x * number X coordinate of curve point.
points[...].shape * string Shape of curve segment between this point and the next.
Possible values:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about WAAPI.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise