HU/PlaySFX - Revision history

EOFIK at 21:12, 17 June 2021

2021-06-17T21:12:22Z

← Older revision		Revision as of 21:12, 17 June 2021
Line 3:		Line 3:
	{{New feature/item\|3.0134\|1.3.4\|5731\|		{{New feature/item\|3.0134\|1.3.4\|5731\|
	This function plays a sound from GTA's big sound containers.		This function plays a sound from GTA's big sound containers.
	}}		\|HU}}

	{{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]].}}
Line 41:		Line 41:
	==Returns==		==Returns==
	Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.		Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
	}}		\|HU}}

	==Example==		==Example==

Surge at 20:26, 19 July 2018

2018-07-19T20:26:18Z

← Older revision		Revision as of 20:26, 19 July 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function hu}}
	{{New feature/item\|3.0134\|1.3.4\|5731\|		{{New feature/item\|3.0134\|1.3.4\|5731\|
	This function plays a sound from GTA's big sound containers.		This function plays a sound from GTA's big sound containers.
Line 52:		Line 52:

	==See Also==		==See Also==
	{{Client_audio_functions}}		{{Client_audio_functions hu}}

	[[en:PlaySFX]]		[[en:PlaySFX]]

Surge: Created page with "NOTOC {{Client function}} {{New feature/item|3.0134|1.3.4|5731| This function plays a sound from GTA's big sound containers. }} {{Note|There is a tool available which al..."

2018-07-19T20:26:04Z

Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0134|1.3.4|5731| This function plays a sound from GTA's big sound containers. }} {{Note|There is a tool available which al..."

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0134|1.3.4|5731|
This function plays a sound from GTA's big sound containers.
}}

{{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)
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==
<syntaxhighlight lang="lua">
element playSFX ( string containerName, int bankId, int soundId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''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"
*'''bankId:''' The audio bank id
*'''soundId:''' The sound id within the audio bank

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped
==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

{{New feature/item|3.0140|1.4|6443|
==Syntax 2==
<syntaxhighlight lang="lua">
element playSFX ( string "radio", string radioStation, int trackId [, bool looped = false ] )
</syntaxhighlight>

===Required Arguments===
*'''radio:''' The string "radio" (used to differentiate to the first syntax)
*'''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".
*'''trackId :''' The radio track id within the radio station audio file

===Optional Arguments===
*'''looped:''' A [[boolean]] representing whether the sound will be looped
==Returns==
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.
}}

==Example==
The following example plays a firealarm sound (looped).
<syntaxhighlight lang="lua">
if not playSFX("script", 7, 1, true) then
outputChatBox("You have to install some missing audio files to hear the sound")
end
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

[[en:PlaySFX]]

HU/PlaySFX - Revision history

EOFIK at 21:12, 17 June 2021

Surge at 20:26, 19 July 2018

Surge: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0134|1.3.4|5731| This function plays a sound from GTA's big sound containers. }} {{Note|There is a tool available which al..."

Surge: Created page with "NOTOC {{Client function}} {{New feature/item|3.0134|1.3.4|5731| This function plays a sound from GTA's big sound containers. }} {{Note|There is a tool available which al..."