PlaySFX3D - Revision history

Myonlake at 22:19, 7 January 2022

2022-01-07T22:19:17Z

← Older revision		Revision as of 22:19, 7 January 2022
Line 10:		Line 10:

	It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).\|true}}		It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).\|true}}
			{{Note\|PlaySFX sounds are MTA driven sounds, so MTA volume affects the volume.}}

	==Syntax==		==Syntax==

Alvesvin at 01:33, 18 August 2021

2021-08-18T01:33:45Z

← Older revision		Revision as of 01:33, 18 August 2021
Line 66:		Line 66:

	[[hu:playSFX3D]]		[[hu:playSFX3D]]
			[[pt-br:playSFX3D]]

Alvesvin: Undo revision 71843 by Alvesvin (talk)

2021-08-18T01:33:25Z

Undo revision 71843 by Alvesvin (talk)

← Older revision		Revision as of 01:33, 18 August 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~BR/Funcao cliente~~}}		{{Client function}}
	{{New feature/item\|3.0134\|1.3.4\|5731\|		{{New feature/item\|3.0134\|1.3.4\|5731\|
	~~Essa função reproduz no mundo um áudio padrão do~~ GTA.		This function plays a sound in the GTA world from GTA's big sound containers.
	}}		}}

	{{Note\|~~Existe uma ferramenta que te permite encontrar as categorias e os~~ IDs ~~dos áudios facilmente~~: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]].}}		{{Note\|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}
	{{~~Aviso~~\|~~Muitos jogadores usam versões do~~ GTA:SA (~~especialmente versões pirateadas~~) ~~ao qual possuem arquivos de áudio preenchidos com~~ zeros ~~para melhorar a compressão da pasta~~ ''AUDIO\SFX\'' (~~eles estão corrompidos~~)~~. No caso desses arquivos de áudio inválidos~~, ~~essa função retorna ''false''. A função também retorna~~ ''false'' ~~ao tentar reproduzir um áudio removido de versões recentes do GTA:SA baixado na Steam~~.~~\|true}}~~		{{Warning\|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
			In case of these invalid audio files, this function returns ''false''.

	==~~Sintaxe~~==		It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).\|true}}

			==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D ( string ~~categoria~~, int ~~idGrupo~~, int ~~idAudio~~, float x, float y, float z [, bool ~~repetir~~ = false ] )		element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Argumentos necessários~~===		===Required Arguments===
	*'''~~categoria~~:''' ~~O nome de uma categoria de efeitos sonoros~~. ~~Valores possíveis são~~: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa".		*'''containerName:''' The name of the audio container. Possible values are: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"
	*'''~~idGrupo~~:''' ~~O ID de um grupo de áudio.~~		*'''bankId:''' The audio bank id
	*'''~~idAudio~~:''' ~~O ID de um áudio dentro do grupo de áudios.~~		*'''soundId:''' The sound id within the audio bank
	*'''x:''' ~~Um [[float]] representando a coordenada~~ X ~~no mapa~~.		*'''x:''' A floating point number representing the X coordinate on the map.
	*'''y:''' ~~Um [[float]] representando a coordenada~~ Y ~~no mapa~~.		*'''y:''' A floating point number representing the Y coordinate on the map.
	*'''z:''' ~~Um [[float]] representando a coordenada~~ Z ~~no mapa~~.		*'''z:''' A floating point number representing the Z coordinate on the map.

	===~~Argumentos opicionais~~===		===Optional Arguments===
	~~{{BR/ArgOpcional}}~~		*'''looped:''' A [[boolean]] representing whether the sound will be looped
	*'''~~repetir~~:''' Um [[boolean]] ~~representando se o áudio deverá se repetir~~.
			==Returns==
			Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

	~~==Retorno==~~
	~~Retorna um elemento de [[sound\|áudio]] se bem sucedido, do contrário retorna ''false''.~~

	{{New feature/item\|3.0140\|1.4\|6443\|		{{New feature/item\|3.0140\|1.4\|6443\|
	==~~Sintaxe~~ 2==		==Syntax 2==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D( string "radio", string ~~estacao~~, int ~~idMusica~~, float x, float y, float z [, bool ~~repetir~~ = false ] )		element playSFX3D( string "radio", string radioStation, int trackId, float x, float y, float z [, bool looped = false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''radio:''' A string "radio" (~~usada para diferenciar da primeira sintaxe~~).		*'''radio:''' The string "radio" (used to differentiate to the first syntax)
	*'''~~estacao~~:''' ~~A estação de rádio~~. ~~Valores possíveis são:~~ "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".		*'''radioStation:''' The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
	*'''~~idMusica~~:''' ~~O ID da música pertencente à estação de rádio.~~		*'''trackId :''' The radio track id within the radio station audio file
	*'''x:''' ~~Um [[float]] representando a coordenada~~ X ~~no mapa~~.		*'''x:''' A floating point number representing the X coordinate on the map.
	*'''y:''' ~~Um [[float]] representando a coordenada~~ Y ~~no mapa~~.		*'''y:''' A floating point number representing the Y coordinate on the map.
	*'''z:''' ~~Um [[float]] representando a coordenada~~ Z ~~no mapa~~.		*'''z:''' A floating point number representing the Z coordinate on the map.

	===~~Argumentos opicionais~~===		===Optional Arguments===
	~~{{BR/ArgOpcional}}~~		*'''looped:''' A [[boolean]] representing whether the sound will be looped
	*'''~~repetir~~:''' Um [[boolean]] ~~representando se o áudio deverá se repetir~~.		==Returns==
			Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
			}}

	~~==Retorno==~~
	~~Retorna um elemento de [[sound\|áudio]] se bem sucedido, do contrário retorna ''false''.~~
	}}

	~~==Exemplo==~~

	~~Este exemplo reproduz repetidamente próximo à você um áudio de alarme de incêndio~~.		==Example==
			The following example plays a fire alarm sound near you (looped).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local x, y, z = getElementPosition(localPlayer)		local x, y, z = getElementPosition(localPlayer)
	if not playSFX3D("script", 7, 1, x + 10, y, z, true) then		if not playSFX3D("script", 7, 1, x + 10, y, z, true) then
	outputChatBox("~~Você precisa instalar alguns arquivos de áudio ausentes~~")		outputChatBox("You have to install some missing audio files to hear the sound")
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	==~~Veja também~~==		==See Also==
	{{~~PT-BR/Funcoes_audio_client~~}}		{{Client_audio_functions}}

	~~[[en:playSFX3D]]~~
	[[hu:playSFX3D]]		[[hu:playSFX3D]]

Alvesvin at 01:31, 18 August 2021

2021-08-18T01:31:55Z

← Older revision		Revision as of 01:31, 18 August 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Client function~~}}		{{BR/Funcao cliente}}
	{{New feature/item\|3.0134\|1.3.4\|5731\|		{{New feature/item\|3.0134\|1.3.4\|5731\|
	~~This function plays a sound in the~~ GTA ~~world from GTA's big sound containers~~.		Essa função reproduz no mundo um áudio padrão do GTA.
	}}		}}

	{{Note\|~~There is a tool available which allows you to find bank and sound~~ IDs ~~easily~~: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}		{{Note\|Existe uma ferramenta que te permite encontrar as categorias e os IDs dos áudios facilmente: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]].}}
	{{~~Warning~~\|~~Many players use versions of~~ GTA:SA (~~especially pirated versions~~) ~~that have audio files full of~~ zeros ~~so that they can compresses better in their~~ ''AUDIO\SFX\'' ~~folder.~~ (~~They lack any data~~)		{{Aviso\|Muitos jogadores usam versões do GTA:SA (especialmente versões pirateadas) ao qual possuem arquivos de áudio preenchidos com zeros para melhorar a compressão da pasta ''AUDIO\SFX\'' (eles estão corrompidos). No caso desses arquivos de áudio inválidos, essa função retorna ''false''. A função também retorna ''false'' ao tentar reproduzir um áudio removido de versões recentes do GTA:SA baixado na Steam.\|true}}
	~~In case of these invalid audio files~~, ~~this function returns~~ ''false''.

	~~It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).\|true}}~~		==Sintaxe==

	==~~Syntax~~==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D ( string ~~containerName~~, int ~~bankId~~, int ~~soundId~~, float x, float y, float z [, bool ~~looped~~ = false ] )		element playSFX3D ( string categoria, int idGrupo, int idAudio, float x, float y, float z [, bool repetir = false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Required Arguments~~===		===Argumentos necessários===
	*'''~~containerName~~:''' ~~The name of the audio container~~. ~~Possible values are~~: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa"		*'''categoria:''' O nome de uma categoria de efeitos sonoros. Valores possíveis são: "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa".
	*'''~~bankId~~:''' ~~The audio bank id~~		*'''idGrupo:''' O ID de um grupo de áudio.
	*'''~~soundId~~:''' ~~The sound id within the audio bank~~		*'''idAudio:''' O ID de um áudio dentro do grupo de áudios.
	*'''x:''' ~~A floating point number representing the~~ X ~~coordinate on the map~~.		*'''x:''' Um [[float]] representando a coordenada X no mapa.
	*'''y:''' ~~A floating point number representing the~~ Y ~~coordinate on the map~~.		*'''y:''' Um [[float]] representando a coordenada Y no mapa.
	*'''z:''' ~~A floating point number representing the~~ Z ~~coordinate on the map~~.		*'''z:''' Um [[float]] representando a coordenada Z no mapa.

	===~~Optional Arguments~~===		===Argumentos opicionais===
	*'''~~looped~~:''' A [[boolean]] ~~representing whether the sound will be looped~~		{{BR/ArgOpcional}}
			*'''repetir:''' Um [[boolean]] representando se o áudio deverá se repetir.
	~~==Returns==~~
	~~Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise~~.

			==Retorno==
			Retorna um elemento de [[sound\|áudio]] se bem sucedido, do contrário retorna ''false''.

	{{New feature/item\|3.0140\|1.4\|6443\|		{{New feature/item\|3.0140\|1.4\|6443\|
	==~~Syntax~~ 2==		==Sintaxe 2==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D( string "radio", string ~~radioStation~~, int ~~trackId~~, float x, float y, float z [, bool ~~looped~~ = false ] )		element playSFX3D( string "radio", string estacao, int idMusica, float x, float y, float z [, bool repetir = false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''radio:''' ~~The~~ string "radio" (~~used to differentiate to the first syntax~~)		*'''radio:''' A string "radio" (usada para diferenciar da primeira sintaxe).
	*'''~~radioStation~~:''' ~~The radio station~~. ~~Possible values are~~ "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".		*'''estacao:''' A estação de rádio. Valores possíveis são: "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
	*'''~~trackId~~ :''' ~~The radio track id within the radio station audio file~~		*'''idMusica:''' O ID da música pertencente à estação de rádio.
	*'''x:''' ~~A floating point number representing the~~ X ~~coordinate on the map~~.		*'''x:''' Um [[float]] representando a coordenada X no mapa.
	*'''y:''' ~~A floating point number representing the~~ Y ~~coordinate on the map~~.		*'''y:''' Um [[float]] representando a coordenada Y no mapa.
	*'''z:''' ~~A floating point number representing the~~ Z ~~coordinate on the map~~.		*'''z:''' Um [[float]] representando a coordenada Z no mapa.

	===~~Optional Arguments~~===		===Argumentos opicionais===
	*'''~~looped~~:''' A [[boolean]] ~~representing whether the sound will be looped~~		{{BR/ArgOpcional}}
	==~~Returns~~==		*'''repetir:''' Um [[boolean]] representando se o áudio deverá se repetir.
	~~Returns a~~ [[sound]] ~~element if the sound was successfully created~~, ''false'' ~~otherwise~~.
			==Retorno==
			Retorna um elemento de [[sound\|áudio]] se bem sucedido, do contrário retorna ''false''.
	}}		}}

			==Exemplo==

			Este exemplo reproduz repetidamente próximo à você um áudio de alarme de incêndio.
	~~==Example==~~
	~~The following example plays a fire alarm sound near you (looped)~~.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local x, y, z = getElementPosition(localPlayer)		local x, y, z = getElementPosition(localPlayer)
	if not playSFX3D("script", 7, 1, x + 10, y, z, true) then		if not playSFX3D("script", 7, 1, x + 10, y, z, true) then
	outputChatBox("~~You have to install some missing audio files to hear the sound~~")		outputChatBox("Você precisa instalar alguns arquivos de áudio ausentes")
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	==~~See Also~~==		==Veja também==
	{{~~Client_audio_functions~~}}		{{PT-BR/Funcoes_audio_client}}

			[[en:playSFX3D]]
	[[hu:playSFX3D]]		[[hu:playSFX3D]]

Qaisjp: fix typo

2020-10-12T20:18:43Z

fix typo

← Older revision		Revision as of 20:18, 12 October 2020
Line 31:		Line 31:


	{{New feature/item\|4.0140\|1.4\|6443\|		{{New feature/item\|3.0140\|1.4\|6443\|
	==Syntax 2==		==Syntax 2==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Surge at 21:27, 19 July 2018

2018-07-19T21:27:15Z

← Older revision		Revision as of 21:27, 19 July 2018
Line 64:		Line 64:
	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions}}

			[[hu:playSFX3D]]

AlexTMjugador: Updated warning according to recent Steam GTA: SA patches

2014-12-30T11:02:58Z

Updated warning according to recent Steam GTA: SA patches

← Older revision		Revision as of 11:02, 30 December 2014
Line 7:		Line 7:
	{{Note\|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}		{{Note\|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}
	{{Warning\|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)		{{Warning\|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
	In case of these invalid audio files, this function returns ''false''\|true}}		In case of these invalid audio files, this function returns ''false''.

			It also returns ''false'' when trying to play a track deleted in the recent GTA: SA Steam patches (and if the client is using a Steam GTA: SA copy).\|true}}

	==Syntax==		==Syntax==

Ccw: Undo revision 43238 by AlexTMjugador (talk)

2014-12-14T19:27:27Z

Undo revision 43238 by AlexTMjugador (talk)

← Older revision		Revision as of 19:27, 14 December 2014
Line 9:		Line 9:
	In case of these invalid audio files, this function returns ''false''\|true}}		In case of these invalid audio files, this function returns ''false''\|true}}

	==Syntax 1==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )		element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )
Line 29:		Line 29:


	{{New feature/item\|3.0140\|1.4\|6443\|		{{New feature/item\|4.0140\|1.4\|6443\|
	==Syntax 2==		==Syntax 2==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

AlexTMjugador at 17:57, 8 December 2014

2014-12-08T17:57:17Z

← Older revision		Revision as of 17:57, 8 December 2014
Line 9:		Line 9:
	In case of these invalid audio files, this function returns ''false''\|true}}		In case of these invalid audio files, this function returns ''false''\|true}}

	==Syntax==		==Syntax 1==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )		element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )
Line 29:		Line 29:


	{{New feature/item\|4.0140\|1.4\|6443\|		{{New feature/item\|3.0140\|1.4\|6443\|
	==Syntax 2==		==Syntax 2==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Jusonex: Reverted changes by AlexTMjugador to avoid misconceptions (you have to substract 1 from all IDs)

2014-06-30T20:12:25Z

Reverted changes by AlexTMjugador to avoid misconceptions (you have to substract 1 from all IDs)

← Older revision		Revision as of 20:12, 30 June 2014
Line 5:		Line 5:
	}}		}}

	{{Note\|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]~~. There's also a online SFX browser [[http://ocain.kilu.de/gtasa_sasp right here]], but it only allows to browse sounds of the ''script'' sound container~~.}}		{{Note\|There is a tool available which allows you to find bank and sound IDs easily: [[https://community.mtasa.com/index.php?p=resources&s=details&id=7549 sfxBrowser:Download]]. }}
	{{Warning\|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)		{{Warning\|Many players use versions of GTA:SA (especially pirated versions) that have audio files full of zeros so that they can compresses better in their ''AUDIO\SFX\'' folder. (They lack any data)
	In case of these invalid audio files, this function returns ''false''\|true}}		In case of these invalid audio files, this function returns ''false''\|true}}