PL/playSound3D: Difference between revisions
ThePiotrek (talk | contribs) No edit summary |
m (GabWas moved page PL/PlaySound3D to PL/playSound3D) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{PL/Client function}} | ||
Funkcja ta tworzy [[element]] [[sound|dźwięku]] oraz odtwarza go dla lokalnego gracza, od razu po wywołaniu funkcji. Jeżeli po stworzeniu dźwięku chcesz zmienić jego pozycję, skorzystaj z funkcji [[setElementPosition]]. | |||
Akutalnie wspierane formaty audio to MP3, WAV, OGG, RIFF, MOD, XM, IT oraz S3M. | |||
{{PL/Note|Ze względu na wydajność, podczas korzystania z funkcji playSound do efektów (np. dźwięki strzelania), zalecana jest konwersja pliku audio z np. MP3 (stereo) do WAV (mono) z częstotliwością 22050 Hz lub niższą. Warto również dodać limit odtwarzania dźwięku np. raz na 50ms.}} | |||
==Składnia== | ==Składnia== | ||
<syntaxhighlight lang="lua">element playSound3D ( string | <syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight> | ||
{{OOP||[[Sound|Sound3D]]}} | |||
===Wymagane argumenty=== | |||
*'''soundPath:''' [[filepath|Ścieżka]] lub adres URL do pliku dźwiękowego, który chcesz odtworzyć. | |||
ⓘ Pliki odtwarzane ze ścieżki, muszą być wcześniej zapisane w pliku [[PL/meta.xml|meta.xml]] korzystając z tagu <file />. | |||
===Wymagane argumenty === | *'''x:''' Liczba zmiennoprzecinkowa określająca współrzędną X dźwięku na mapie. | ||
*''' | *'''y:''' Liczba zmiennoprzecinkowa określająca współrzędną Y dźwięku na mapie. | ||
*'''x:''' | *'''z:''' Liczba zmiennoprzecinkowa określająca współrzędną Z dźwięku na mapie. | ||
*'''y:''' | |||
*'''z:''' | |||
===Opcjonalne argumenty=== | ===Opcjonalne argumenty=== | ||
{{OptionalArg}} | {{PL/OptionalArg}} | ||
*'''zapętlony:''' | *'''looped:''' [[Boolean]] decydujący o tym, czy dźwięk ma zostać zapętlony. Aby tak się stało, użyj ''true''. Domyślnie ''false''. | ||
ⓘ Zapętlanie nie jest możliwe w przypadku stream'ów (np. radio). | |||
{{New feature/item|3.0150|1.5|| | |||
*'''throttled:''' [[Boolean]] decydujący o tym, czy dźwięk z adresu URL ma być odtwarzany z niską przepustowością łącza. Aby tak się stało, użyj ''true''. Domyślnie ''true''. | |||
ⓘ Odtwarzanie z niską przepustowością łącza dotyczy tylko plików odtwarzanych z adresów URL. | |||
}} | |||
===Wynik=== | |||
Zwraca [[element]] [[sound|dźwięku]] jeżeli został on pomyślnie stworzony. W przeciwnym wypadku zwraca ''false''. | |||
==Przykłady== | |||
<section name="Przykład nr 1" class="client" show="true" > | |||
Ten przykład odtwarza radio RMF MAXXX w okolicach Grove Street. | |||
== | |||
<section name="Przykład" class="client" show="true"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function radioNaGrove ( ) -- tworzymy funkcję odpowiadającą za odtwarzanie się radia | ||
local radio = playSound3D( 'http://files.kusmierz.be/rmf/rmfmaxxx.pls', 2498, -1659, 12 ) -- tworzymy dźwięk... | |||
setSoundMaxDistance( radio, 100 ) -- ...oraz zmieniamy jego odległość, na którą można go będzie usłyszeć (opcjonalne) | |||
end | end | ||
addEventHandler("onClientResourceStart", getResourceRootElement | addEventHandler ( "onClientResourceStart", getResourceRootElement(), radioNaGrove ) -- na koniec nie zapominamy o eventHandlerze | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
<br/> | |||
''Autor: [[User:GabWas|GabWas]]; utworzono: 12:16, 21 Lip 2016 (CEST)'' | |||
<br/>''Author: [[User:GabWas|GabWas]]; created: 10:16, 21 Jul 2016 (UTC)'' | |||
==Zobacz | ==Zobacz również== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[en:playSound3D]] | |||
[[AR:playSound3D]] | [[AR:playSound3D]] | ||
[[DE:playSound3D]] | [[DE:playSound3D]] | ||
[[RU:playSound3D]] | [[RU:playSound3D]] |
Latest revision as of 11:14, 21 July 2016
Funkcja ta tworzy element dźwięku oraz odtwarza go dla lokalnego gracza, od razu po wywołaniu funkcji. Jeżeli po stworzeniu dźwięku chcesz zmienić jego pozycję, skorzystaj z funkcji setElementPosition. Akutalnie wspierane formaty audio to MP3, WAV, OGG, RIFF, MOD, XM, IT oraz S3M.
Notatka: Ze względu na wydajność, podczas korzystania z funkcji playSound do efektów (np. dźwięki strzelania), zalecana jest konwersja pliku audio z np. MP3 (stereo) do WAV (mono) z częstotliwością 22050 Hz lub niższą. Warto również dodać limit odtwarzania dźwięku np. raz na 50ms. |
Składnia
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(...)
Wymagane argumenty
- soundPath: Ścieżka lub adres URL do pliku dźwiękowego, który chcesz odtworzyć.
ⓘ Pliki odtwarzane ze ścieżki, muszą być wcześniej zapisane w pliku meta.xml korzystając z tagu <file />.
- x: Liczba zmiennoprzecinkowa określająca współrzędną X dźwięku na mapie.
- y: Liczba zmiennoprzecinkowa określająca współrzędną Y dźwięku na mapie.
- z: Liczba zmiennoprzecinkowa określająca współrzędną Z dźwięku na mapie.
Opcjonalne argumenty
UWAGA: Kiedy korzystasz z opcjonalnych argumentów, musisz uzupełnić wszystkie argumenty przed tym, którego chcesz użyć. Aby uzyskać więcej informacji na ten temat, zajrzyj tutaj.
- looped: Boolean decydujący o tym, czy dźwięk ma zostać zapętlony. Aby tak się stało, użyj true. Domyślnie false.
ⓘ Zapętlanie nie jest możliwe w przypadku stream'ów (np. radio).
- throttled: Boolean decydujący o tym, czy dźwięk z adresu URL ma być odtwarzany z niską przepustowością łącza. Aby tak się stało, użyj true. Domyślnie true.
ⓘ Odtwarzanie z niską przepustowością łącza dotyczy tylko plików odtwarzanych z adresów URL.
Wynik
Zwraca element dźwięku jeżeli został on pomyślnie stworzony. W przeciwnym wypadku zwraca false.
Przykłady
Ten przykład odtwarza radio RMF MAXXX w okolicach Grove Street.
function radioNaGrove ( ) -- tworzymy funkcję odpowiadającą za odtwarzanie się radia local radio = playSound3D( 'http://files.kusmierz.be/rmf/rmfmaxxx.pls', 2498, -1659, 12 ) -- tworzymy dźwięk... setSoundMaxDistance( radio, 100 ) -- ...oraz zmieniamy jego odległość, na którą można go będzie usłyszeć (opcjonalne) end addEventHandler ( "onClientResourceStart", getResourceRootElement(), radioNaGrove ) -- na koniec nie zapominamy o eventHandlerze
Autor: GabWas; utworzono: 12:16, 21 Lip 2016 (CEST)
Author: GabWas; created: 10:16, 21 Jul 2016 (UTC)
Zobacz również
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd