PL/playSound3D: 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}}
Tworzy element [[dźwięku]] w świecie GTA i odtwarza go po stworzeniu go dla gracza lokalnego. Funkcja [[setElementPosition]] może być użyta by przenieść [[dźwięk]] po tym, jak został on stworzony. Zapamiętaj by użyć [[setElementDimension]] jeśli chcesz by dźwięk grał w innym wymiarze niż 0.<br />
Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
{{Note|For performance reasons, when using playSound3D 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.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound|Sound3D]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag. And also can use url instead of [[filepath]] )
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.


'''Notatka:''' Jedyne wspierane formaty to: MP3, WAV, OGG, RIFF, MOD, XM, IT i S3M.
===Optional Arguments===  
 
 
 
==Składnia==
<syntaxhighlight lang="lua">element playSound3D ( string link/ścieżka do pliku, pozycja x, pozycja y, pozycja z, [ bool zapętlony = false ] )</syntaxhighlight>
 
 
 
 
===Wymagane argumenty ===
*'''link/ścieżka do pliku:''' Link lub ścieżka do pliku który chcesz odtwarzać. (Pliki muszą być zdefiniowane w [[meta.xml]] pomiędzy tagami <file />. Możesz użyć także URL. )
*'''x:''' Pozycja X na mapie na której ma grać dźwięk.
*'''y:''' Pozycja Y na mapie na której ma grać dźwięk.
*'''z:''' Pozycja Z na mapie na której ma grać dźwięk.
 
 
===Opcjonalne argumenty===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''zapętlony:''' Wartość typu [[boolean]] reprezentująca, czy dźwięk ma być zapętlany. By zapętlić dźwięk, użyj ''true''.
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). 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==  
===Zwracane argumenty===
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
Zwraca element [[dźwięku]] jeśli zostanie on poprawnie stworzony, lub ''false'' jeśli nie zostanie on poprawnie stworzony.
<section name="Example" class="client" show="true">
 
 
 
 
==Przykład==  
Ten przykład tworzy zapętlony dźwięk w pizzeri. Pizzeria jest umiejscowiona w San Fierro nie daleko Pier 69
<section name="Przykład" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onResourceStart()
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)  
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)  
end
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)
addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
 
This example play internet radio in groove street.
 
<section name="Example 2" class="client" show="true" >
 
 
Ten przykład odtwarza radio internetowe na Grove Street.
<section name="Przykład 2" class="client" show="true" >
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( 'onClientResourceStart', resourceRoot,
addEventHandler( 'onClientResourceStart', resourceRoot,
Line 58: Line 46:
</section>
</section>


 
==See Also==
==Zobacz także==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[AR:playSound3D]]
[[AR:playSound3D]]
[[DE:playSound3D]]
[[DE:playSound3D]]
[[RU:playSound3D]]
[[RU:playSound3D]]

Revision as of 09:24, 21 July 2016

Creates a sound element in the GTA world and plays it immediately after creation for the local player. setElementPosition can be used to move the sound element around after it has been created. Remember to use setElementDimension after creating the sound to play it outside of dimension 0.

Note: The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.

[[{{{image}}}|link=|]] Note: For performance reasons, when using playSound3D 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.

Syntax

element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false, bool throttled = true ] )

OOP Syntax Help! I don't understand this!

Method: Sound3D(...)


Required Arguments

  • soundPath: the filepath to the sound file you want to play. (Sound file has to be predefined in the meta.xml file with <file /> tag. And also can use url instead of filepath )
  • 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

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 looped. To loop the sound, use true.
  • throttled: a boolean representing whether the sound will be throttled (i.e. given reduced download bandwidth). 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

This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69

Click to collapse [-]
Example
function onResourceStart()
	local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true) 
end
addEventHandler("onClientResourceStart", resourceRoot, onResourceStart)

This example play internet radio in groove street.

Click to collapse [-]
Example 2
addEventHandler( 'onClientResourceStart', resourceRoot,
	function( )
		local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 ) 
		setSoundMaxDistance( uSound, 100 )
	end
)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/PL/playSound3D?oldid=48286"