PlaySFX3D

From Multi Theft Auto: Wiki
Revision as of 11:46, 27 August 2013 by Lexr128 (talk | contribs) (Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0134|1.3.4|5731| This function plays a sound in the GTA world from GTA's big sound containers. }} {{Note|There is a tool avai...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function plays a sound in the GTA world from GTA's big sound containers.

[[{{{image}}}|link=|]] Note: There is a tool available which allows you to find bank and sound IDs easily: [sfxBrowser:Download]
Dialog-warning.png Warning: Many players use versions of GTA:SA (especially pirated versions) which do not have any audio files in their AUDIO\SFX\ folder. In case of missing audio files, this function returns false

Syntax

element playSFX3D ( string containerName, int bankId, int soundId, float x, float y, float z [, bool looped = false ] )

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
  • x: A floating point number representing the X coordinate on the map.
  • y: A floating point number representing the Y coordinate on the map.
  • z: A floating point number representing the Z coordinate on the map.

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 near you (looped).

local x, y, z = getElementPosition(localPlayer)
if not playSFX("script", 7, 1, x + 10, y, z, true) then
    outputChatBox("You have to install some missing audio files to hear the sound")
end

See Also