PlaySound: Difference between revisions
Jump to navigation
Jump to search
Cazomino05 (talk | contribs) |
Cazomino05 (talk | contribs) m (removed todo) |
||
Line 16: | Line 16: | ||
==Example== | ==Example== | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> |
Revision as of 21:26, 26 December 2008
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 [-]
Clientfunction 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
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd