PlaySound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
Crea un sonido (elemento) y lo reproduce inmediatamente después de la creación para el jugador local.<br />
<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).
'''Nota:''' Los únicos formatos de audio soportados son: MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M y PLS(EJ: Webstream).
{{Note|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.}}
{{Nota|Para que los sonidos usados no den lag al usarse mucho (EJ: cuando disparas un arma), es recomendado que conviertas tu audio en 1 solo canal (mono) WAV con menos de 22050 Hz. También puede ayudar agregar un limitador de veces por X tiempo. EJ: 50ms.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>  
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>  
Line 12: Line 12:
{{OOP||[[Sound]].create}}
{{OOP||[[Sound]].create}}
===Required Arguments===  
===Required Arguments===  
*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)
*'''soundPath:''' el archivo o el URL de la Radio o Sonido el cual quieres que se reproduzca. En caso de ser un archivo propio, deberá de ser marcado en [[meta.xml]]


===Optional Arguments===  
===Argumentos Opcionales===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''looped:''' 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.
*'''looped:''' Un [[boolean]] que representa si el sonido se repetirá infinitamente o no. Por defecto es ''false''
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.


Revision as of 08:04, 18 May 2015

Crea un sonido (elemento) y lo reproduce inmediatamente después de la creación para el jugador local.

Nota: Los únicos formatos de audio soportados son: MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M y PLS(EJ: Webstream).

Nota: Para que los sonidos usados no den lag al usarse mucho (EJ: cuando disparas un arma), es recomendado que conviertas tu audio en 1 solo canal (mono) WAV con menos de 22050 Hz. También puede ayudar agregar un limitador de veces por X tiempo. EJ: 50ms.

Syntax

element playSound ( string soundPath, [ bool looped = false ] )
element playSound ( string soundPath, [ bool looped = false, [ bool throttled = true ] ] )

OOP Syntax Help! I don't understand this!

Method: Sound.create(...)


Required Arguments

  • soundPath: el archivo o el URL de la Radio o Sonido el cual quieres que se reproduzca. En caso de ser un archivo propio, deberá de ser marcado en meta.xml

Argumentos Opcionales

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: Un boolean que representa si el sonido se repetirá infinitamente o no. Por defecto es false
  • throttled: a boolean representing whether the sound will be throttled. To throttle the sound, use true. Sounds will be throttled per default and only for URLs.

Returns

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

Example

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

Retrieved from "https://wiki.multitheftauto.com/wiki/PlaySound?oldid=45202"