Zum Inhalt

soundset

Quelle: base/tealdef/scripts/soundset.d.tl

Hinweise

Typen der Update-Skripte von Sound-Sets (siehe /scripts/soundset_default.script.tl): das Ausgabeobjekt, das Lautstärke und Tonhöhe für Spuren und Events aufnimmt, und die Parameter-Records eigener und kurvenbasierter Update-Funktionen.

SoundTransfOutput

record global base/tealdef/scripts/soundset.d.tl:4

global record SoundTransfOutput

Sound Transformation output, which contains user transformations of events and tracks from transformation lua scripts

Funktionen

addTrack(soundTransfOutput : SoundTransfOutput, gain : number, pitch : number) base/tealdef/scripts/soundset.d.tl:5

Aufruf: soundTransfOutput:addTrack(…) (Methode)

Hinweise

Setzt Lautstärke und Tonhöhe der nächsten Tonspur des Sound-Sets.

Parameter Typ Beschreibung
soundTransfOutput SoundTransfOutput
gain number Lautstärkefaktor.
pitch number Tonhöhenfaktor (1 = unverändert).

Details

Die Spuren werden der Reihe nach gefüllt. Laut dem Standard-Skript ist die Reihenfolge bei den Auspuffschlägen von Dampfzügen wichtig.

Im Basisspiel verwendet: 3-mal in 1 Datei

base/content/scripts/scripts/soundset_default.script.tl:203

soundTransfOutput:addTrack(

addEvent(soundTransfOutput : SoundTransfOutput, event : string, gain : number, pitch : number) base/tealdef/scripts/soundset.d.tl:6

Aufruf: soundTransfOutput:addEvent(…) (Methode)

Hinweise

Setzt Lautstärke und Tonhöhe des benannten Sound-Events.

Parameter Typ Beschreibung
soundTransfOutput SoundTransfOutput
event string Event-Schlüssel aus dem Sound-Set.
gain number Lautstärkefaktor.
pitch number Tonhöhenfaktor.
Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/scripts/scripts/soundset_default.script.tl:197

soundTransfOutput:addEvent(

triggerEvent(soundTransfOutput : SoundTransfOutput, event : string, gain : number, pitch : number) base/tealdef/scripts/soundset.d.tl:7

Aufruf: soundTransfOutput:triggerEvent(…) (Methode)

Hinweise

Löst das benannte Sound-Event einmal mit der angegebenen Lautstärke und Tonhöhe aus.

Parameter Typ Beschreibung
soundTransfOutput SoundTransfOutput
event string Event-Schlüssel aus dem Sound-Set.
gain number Lautstärkefaktor.
pitch number Tonhöhenfaktor.
Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/scripts/scripts/soundset_default.script.tl:174

soundTransfOutput:triggerEvent(

CustomUpdateScript

record global base/tealdef/scripts/soundset.d.tl:10

global record CustomUpdateScript

Hinweise

Skriptverweis auf eine eigene Sound-Update-Funktion (Custom), die eine Tonspur steuert.

Funktionen

updateFn(result : GainPitch, customParams : any, currentInfoParams : {string : {string : number}}) base/tealdef/scripts/soundset.d.tl:11

Hinweise

Berechnet Lautstärke und Tonhöhe einer Tonspur und schreibt sie in result.

Parameter Typ Beschreibung
result GainPitch Ausgabe, vorbelegt mit Lautstärke 1 und Tonhöhe 1.
customParams any Die im Sound-Set angegebenen customParams.
currentInfoParams {string : {string : number}} Aktuelle Transformator-Infos (TransformatorParams.currentInfo) als verschachtelte Tabellen aus Zahlen.

CustomUpdateEventScript

record global base/tealdef/scripts/soundset.d.tl:13

global record CustomUpdateEventScript

Hinweise

Skriptverweis auf eine eigene Sound-Update-Funktion (Custom), die ein Event auslöst.

Funktionen

updateFn(result : GainPitchTrigger, customParams : any, currentInfoParams : {string : {string : number}}, previousInfoParams : {string : {string : number}}) base/tealdef/scripts/soundset.d.tl:14

Hinweise

Entscheidet, ob das Event ausgelöst wird und mit welcher Lautstärke und Tonhöhe.

Parameter Typ Beschreibung
result GainPitchTrigger Ausgabe, vorbelegt mit Lautstärke 1, Tonhöhe 1 und trigger = false. Setze trigger = true, um das Event auszulösen.
customParams any Die im Sound-Set angegebenen customParams.
currentInfoParams {string : {string : number}} Aktuelle Transformator-Infos als verschachtelte Tabellen aus Zahlen.
previousInfoParams {string : {string : number}} Die Infos des vorigen Schritts, um Änderungen zu erkennen.

GainPitch

record global base/tealdef/scripts/soundset.d.tl:17

global record GainPitch

Hinweise

Lautstärke und Tonhöhe einer Tonspur oder eines Events.

Felder

Name Typ Beschreibung
gain number Lautstärkefaktor.
pitch number Tonhöhenfaktor (1 = unverändert).

GainPitchTrigger

record global base/tealdef/scripts/soundset.d.tl:22

global record GainPitchTrigger

Hinweise

Lautstärke und Tonhöhe eines Sound-Events und ob es jetzt ausgelöst wird.

Felder

Name Typ Beschreibung
gain number Lautstärkefaktor.
pitch number Tonhöhenfaktor.
trigger boolean True löst das Event in diesem Schritt aus.

SampleCurveParams

record global base/tealdef/scripts/soundset.d.tl:28

global record SampleCurveParams

Hinweise

Parameter der Sound-Update-Funktion SampleCurve. Sie liest Werte aus den Transformator-Infos und bildet sie über Kurven ab.

Felder

Name Typ Beschreibung
gainCurve {{number, number}} Liste von {x, y}-Knoten, die den Eingangswert auf die Lautstärke abbilden.
pitchCurve {{number, number}} Liste von {x, y}-Knoten, die den Eingangswert auf die Tonhöhe abbilden.
gainScriptingInfoKey string Schlüssel der Info-Tabelle in currentInfo (z. B. vehicle), die den Eingangswert für die Lautstärke enthält.
gainParamName string Name des Werts in dieser Tabelle, der die Lautstärke steuert (z. B. speed).
pitchScriptingInfoKey string Schlüssel der Info-Tabelle in currentInfo, die den Eingangswert für die Tonhöhe enthält.
pitchParamName string Name des Werts in dieser Tabelle, der die Tonhöhe steuert.