playSound3D | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

playSound3D

Client-side
Server-side
Shared

Creates a sound element in the GTA world and plays it immediately after creation for the local player. setElementPosition can be used to move the sound element around after it has been created. Remember to use setElementDimension after creating the sound to play it outside of dimension 0.

Note
  • The only supported audio formats are MP3, WAV, OGG, FLAC, RIFF, MOD, WEBM, XM, IT, S3M and PLS (e.g. Webstream).
  • For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.
  • Playing sound files from other resources requires the target resource to be in the running state.

OOP Syntax Help! I don't understand this!

Syntax

sound|false playSound3D ( string soundPathOrData, float x, float y, float z, [ bool looped = false, bool throttled = true ] )
Required Arguments
  • soundPathOrData: filepath, raw data or URL (http://, https:// or ftp://) of the sound file you want to play.
  • x: A floating point number representing the X coordinate on the map.
  • y: A floating point number representing the Y coordinate on the map.
  • z: A floating point number representing the Z coordinate on the map.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • looped (default: false): A boolean representing whether the sound will be looped. To loop the sound, use true. Loop is not available for streaming sounds, only for sound files.
  • throttled (default: true): A boolean representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use true. Sounds will be throttled per default and only for URLs.

Returns

  • sound|false: soundElement

Returns a sound element if the sound was successfully created, false otherwise.

Code Examples

client

This example creates a looping sound within a pizza shop. It's located in San Fierro near Pier 69.

function onResourceStart()
  local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)

See Also

Audio Functions
Audio Elements
Reference