DE/playSound: Difference between revisions

Revision as of 20:57, 24 October 2016

Erstellt ein Sound Element und spielt es sofort ab für den lokalen Spieler.

Bemerkung: * Die unterstützten Audio Formate sind MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M und PLS(z.b. Webstream).

Aus Performance Gründen wird empfohlen, wenn playSound3D für Effekte genutzt wird, die Audio Datei in einen Kanal (Mono) WAV zu konvertieren mit einer Beispielrate von 22050 Hz oder weniger. Bedenke auch ein Limit hinzuzufügen wie oft der Effekt abgespielt werden kann, z.B. alle 50ms

Syntax

element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )

OOP Syntax Help! I don't understand this!

Method: Sound(...)

Benötigte Argumente

soundPath: der Dateipfad zur Datei, die du spielen möchtest. (Die Sounddatei muss in der meta.xml Datei definiert sein mit dem <file /> Tag. Du kannst auch URLs statt Pfade nehmen.)

Optionale Argumente

HINWEIS: Bei der Verwendung von optionalen Argumenten, müssen alle Argumente vor dem gewünschten Argument bestimmt werden. Mehr Informationen unter Optionale Argumente.

looped: Ein boolean Wert, der angibt ob der Sound wiederholt werden soll. Um den Sound in Dauerschleife zu wiederholen, nutze true. Wiederholungen gelten nicht für Streams, nur für Dateien.

throttled: Ein boolean Wert, der angibt ob der Sound gedrosselt werden soll (z.B. bei geringer Download Bandbreite). Um den Sound zu drosseln, nutze true. Drosseln funktioniert nur bei Streams und wird standardmäßig ausgeführt.

Rückgabe

Gibt ein Sound Element zurück wenn es erfolgreich erstell wurde, ansonsten false.

Beispiel

function wasted (killer, weapon, bodypart) 
	local sound = playSound("sounds/wasted.mp3") --Spielt wasted.mp3 vom sounds Ordner ab
	setSoundVolume(sound, 0.5) -- setzt die Lautstärke auf 50%
end

addEventHandler("onClientPlayerWasted", localPlayer, wasted)

Siehe auch

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{DE/Client function}}
-Spielt einen gewünschten Sound beim Clienten ab. Funktioniert auch beim Streamen.
+Erstellt ein [[Sound]] [[Element]] und spielt es sofort ab für den lokalen Spieler.<br />
-'''Erlaubte Formate''': MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
+<br />
+{{DE/Note|* Die unterstützten Audio Formate sind MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M und PLS(z.b. Webstream).
+* Aus Performance Gründen wird empfohlen, wenn playSound3D für Effekte genutzt wird, die Audio Datei in einen Kanal (Mono) WAV zu konvertieren mit einer Beispielrate von 22050 Hz oder weniger. Bedenke auch ein Limit hinzuzufügen wie oft der Effekt abgespielt werden kann, z.B. alle 50ms}}
+==Syntax==
+<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
+{{OOP||[[Sound]]}}
+===Benötigte Argumente===
+*'''soundPath:''' der Dateipfad zur Datei, die du spielen möchtest. (Die Sounddatei muss in der meta.xml Datei definiert sein mit dem <file /> Tag. Du kannst auch URLs statt Pfade nehmen.)
-== Syntax ==
+===Optionale Argumente===
-<section name="Client" class="client" show="true">
+{{DE/OptionalArg}}
-<syntaxhighlight lang="lua">
+*'''looped:''' Ein [[boolean]] Wert, der angibt ob der Sound wiederholt werden soll. Um den Sound in Dauerschleife zu wiederholen, nutze true. Wiederholungen gelten nicht für Streams, nur für Dateien.
-bool playSound( float file, bool delay )
+{{New feature/item|3.0150|1.5||
-</syntaxhighlight>
+*'''throttled:''' Ein [[boolean]] Wert, der angibt ob der Sound gedrosselt werden soll (z.B. bei geringer Download Bandbreite). Um den Sound zu drosseln, nutze true. Drosseln funktioniert nur bei Streams und wird standardmäßig ausgeführt.
+}}
-===Benötigte Argumente:===
+===Rückgabe===
-*'''file:''': Pfad zur wiedergebenden Datei
+Gibt ein [[Sound]] [[Element]] zurück wenn es erfolgreich erstell wurde, ansonsten ''false''.
-*'''delay:''' ''true'' wenn der Sound wiederholt werden soll, ''false'' wenn nicht
-</section>
+==Beispiel==
-===Rückgaben===
+<syntaxhighlight lang="lua">
-Gibt ''true'' zurück, wenn der Sound erfolgreich abgespielt wurde. ''false'', wenn nicht.
+function wasted (killer, weapon, bodypart)
+	local sound = playSound("sounds/wasted.mp3") --Spielt wasted.mp3 vom sounds Ordner ab
+	setSoundVolume(sound, 0.5) -- setzt die Lautstärke auf 50%
+end
-== Beispiel: ==
+addEventHandler("onClientPlayerWasted", localPlayer, wasted)
+</syntaxhighlight>
-<section name="Client" class="client" show="true">
+==Siehe auch==
-Sobald der Spieler joint wird ein Stream gestartet zu Technobase
+{{DE/Client_audio_functions}}
-<syntaxhighlight lang="lua">
+[[AR:playSound]]
-addEventHandler("onClientPlayerJoin", getRootElement(), function()
+[[DE:playSound]]
- if source == getLocalPlayer() then
-  local sound = playSound("http://technobase.com/wave.mp3", false)
- end
-end)
-</syntaxhighlight>
-</section>