PlaySound3D

From Multi Theft Auto: Wiki
Revision as of 19:39, 20 July 2010 by 50p (talk | contribs) (Required Arguments)

Jump to: navigation, search

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.

Note: The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

Syntax

element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )

Required Arguments

  • soundPath: The filepath to the sound file you want to play. (Sound file has to be predefined in the meta.xml file with <file /> tag.)
  • 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. For more information on optional arguments, see optional arguments.

  • looped: A boolean representing whether the sound will be looped. To loop the sound, use true.

Returns

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

Example

This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69

Click to collapse [-]
Client
function onResourceStart()
	local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) 
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)

See Also

FROM VERSION 1.5.6 r16216 ONWARDS