PlaySound

From Multi Theft Auto: Wiki
Revision as of 21:26, 26 December 2008 by Cazomino05 (talk | contribs) (removed todo)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Creates a sound element and plays it immediately after creation for the local player.

Syntax

element playSound ( string soundName, [ bool looped ] )

Required Arguments

  • soundName: Name of the sound file you want to play. (Sound file has to be predefined in the client side meta.xml file with <file /> tags.)

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 looping or not. To loop the sound, use true.

Returns

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

Example

Click to collapse [-]
Client
function wasted (killer, weapon, bodypart) 
	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
	setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler

See Also