Firelight Technologies FMOD Studio API

Studio::EventDescription::getMinimumDistance

Retrieves the minimum distance for 3D attenuation of the event.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getMinimumDistance(
  float *distance
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetMinimumDistance(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  float *distance
);

C# Syntax

RESULT Studio.EventDescription.getMinimumDistance(
  out float distance
);

JavaScript Syntax

EventDescription.getMinimumDistance(
  distance                         // writes value to distance.val
);

Parameters

distance

Address of a variable to receive the distance.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

This is the smallest Min Distance value out of all of the event's 3D Panners, or zero if there are no 3D Panners.

Version 1.10.03 Built on Feb 1, 2018