Open Dev Kit Documentation :: Audio :: Play Audio

Audio.Play(
  Audio Audio*,
  Volume Float,
  Pitch Float,
  Loop Boolean,
  Volume Fade In Float,
  Position 3D Vector,
  Relative To Listener Boolean,
  Range Float,
  Attenuation Float
) 

Parameters

Audio Audio*

Volume Float

Pitch Float

Loop Boolean

Volume Fade In Float

Position 3D Vector

Relative To Listener Boolean

Forces audio to follow the listener

Range Float

How far away the sound can be heard; 0 for infinite

Attenuation Float

Factor of how much distance diminishes intensity (0 = constant intensity, 1 = distance reduces intensity naturally)

Return Value

Nothing

Lua Usage

Audio.Play(audio, volume, pitch, loop, volumeFadeIn, position, relativeToListener, range, attenuation)

If you think anything is missing, please feel free to: submit documentation feedback on this page