Quelltext der Seite Standardisierte Script-Events und -Variablen

{{ArticleMetadata
|author=Marcel Kuhnt
|created_date=2017-07-14T08:49:22+02:00
|modified_date=2022-07-10T01:03:10+02:00
|source_url=https://www.lotus-simulator.de/lexikon/index.php?entry/36-standardisierte-script-events-und-variablen/
}}

Damit alle hardwareseitige Kommunikation mit neuen Fahrzeugen so einheitlich wie möglich erfolgen kann, ist es nötig, dass sich Fahrzeug-Scripter streng an die hier definierten Standards halten!  
  
Betroffen sind hierbei insbesondere die Bezeichnung von Tastatur-, Maus- und Gamecontroller-Tasten-Eingaben (normale Events), Eingaben von Gamecontroller-Achsen oder Plugin-Schnittstellen sowie eine einheitliche Bezeichnung von Variablen, damit Plugin-Schnittstellen zu möglichst vielen verschiedenen Fahrzeugen kompatibel sind. 

== 1  Allgemeines  ==

Wichtig ist nicht nur, dass die hier gewählten Namen für Events, Achsen und Variablen verwendet werden. Ebenso wichtig ist es, möglichst alle hier aufgelisteten Events anzubieten! Denn auch falls seitens der Mausevents beispielsweise nur "Door1Open" und "Door1Close" benötigt werden, sollte dennoch auch das Event "Door1Toggle" mit einprogrammiert werden, damit Anwender, die sich hierfür bereits eine Tastenkombination eingerichtet haben, diese auch verwenden können.

  

Beim Scripten von Gamecontroller-Achsen sollten alle in Frage kommenden Achsen vorgesehen werden; beispielsweise sollen Sollwertgeber sowohl auf reine "Throttle"-Achseingaben reagieren, aber auch auf Eingaben von Kombihebel-Eingaben.

== 2  Tastatur-, Mausklick- und Gamecontroller-Tasten-Events  ==

== 2.1  Bahn-Steuerung  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
**Throttle** | Schub / Gas / Beschleunigung (nur Straßenfahrzeuge oder Bahnen mit kombinierte Steuerelementen) | Einleitung und Erhöhung des Vortriebs.  
  
Straßenfahrzeuge: Zunächst ggf. sofortiges und komplettes Loslassen des Bremspedals, anschließend während Tastendrucks zügiges Treten des Gaspedals Richtung "mittelhohes Vollgas", nach Loslassen wieder behutsames Loslassen des Gaspedals  
Bahnen mit Sollwertgeber: Kontinuierliche Vorwärtsbewegung, zeitweises Warten oder Erwarten des Absetzens und Neudrückens bei Rasten.  
Bahnen mit kombinierter Fahrkurbel oder Fahrstufenrad: Pro Tastendruck Bewegung der Fahrkurbel um eine Raste Richtung Höchstleistung  
  
**Neutral** | Sofortige Neutralstellung / Loslassen des Brems- und Gaspedal | Straßenfahrzeuge: Sofortiges und komplettes Loslassen von Gas- und Bremspedal  
Bahnen mit Sollwertgeber oder kombinierter Fahrkurbel: Sehr zügiges und vollständiges Bewegen in die Neutralstellung  
**Brake** | Bremse (nur Straßenfahrzeuge oder Bahnen mit kombinierte Steuerelementen) | Straßenfahrzeuge: Zunächst ggf. sofortiges, komplettes Loslassen des Gaspedals, anschließend kontinuierliches Eröhen der Bremskraft und nach Loslassen Beibehaltung derselben  
Bahnen mit Sollwertgeber: Kontinuierliche Rückwärtsbewegung, zeitweises Warten oder Erwarten des Absetzens und Neudrückens bei Rasten.  
Bahnen mit kombinierter Fahrkurbel: Pro Tastendruck Bewegung der Fahrkurbel um eine Raste Richtung Bremsen  
  
MaxBrake | Schnellbremse | Straßenfahrzeuge: Gaspedal loslassen, sofortiges Durchtreten des Bremspedals  
Bahnen: Sofortiges Betätigen der Schnellbremse  
EmergencyBrake | Notbremse | Betätigen eines eventuell vorhandenen Notbremsknopfes  
HoldToRun | Totmann-Taster | Für Fahrzeuge mit Sicherheitsfahrschaltung  
RunButton | Fahrtaster |   
  
ReverserPlus | Fahrtrichtungswender Richtung Vorwärts |   
ReverserMinus | Fahrtrichtungswender Richtung Rückwärts |   
Reverser0 | Fahrtrichtungswender direkt auf Stellung "0" |   
ReverserI | Fahrtrichtungswender direkt auf Stellung "I" oder "*" |   
ReverserR | Fahrtrichtungswender direkt auf Stellung "R" |   
ReverserV | Fahrtrichtungswender direkt auf Stellung "V" |   
RailBrake | Schienenbremse | Falls mehrere Taster vorhanden sind, dann sollte dieses Event entweder den Taster betätigen, bei dem die meisten Schienenbremsen bzw. die größte Bremsleistung erbracht wird oder welcher üblicherweise zuerst oder hauptsächlich verwendet wird  
RailBrake2 | Sekundäre Schienenbremstaste |   
Sanding | Sandstreuer |   
InsertKey_Reverser | Richtungswender-Schlüssel einstecken | Einstecken des Schlüssel, der den Richtungswender sperrt  
Key_Reverser_R | Richtungswender-Schlüssel "Zu", dann abziehen | Schlüssel, der den Richtungswender sperrt, Richtung "abgeschlossen" drehen, falls geschehen, dann abziehen  
Key_Reverser_L | Richtungswender-Schlüssel "Auf" | Schlüssel, der den Richtungswender sperrt, Richtung "offen" drehen  
SwitchToggleButton | Weichenstelltaster | Zum Umstellen der Weiche bei der klassischen Weichensteuerung per Oberleitungskontakt o.Ä..  
SwitchLeft | Weichenstelltaster | Weiche links  
SwitchRight | Weichenstelltaster | Weiche rechts  
SwitchStraight | Weichenstelltaster | Weiche geradeaus  
BrakePlus | Bremshebelstufe erhöhen | Bedienung eines reinen Zugbremshebels/-ventils: Üblicherweise zu einem hin  
BrakeMinus | Bremshebelstufe verringern | Bedienung eines reinen Zugbremshebels/-ventils: Üblicherweise von einem weg  
SetBrakeDrive | Bremshebelstufe "Fahren" einlegen | Zugbremshebel-/ventil direkt auf die "Fahren"-Stellung stellen  
SetBrakeRelease | Bremshebelstufe "Lösen" einlegen | Zugbremshebel-/ventil direkt auf die "Lösen"-Stellung stellen  
SetBrakeClosed | Bremshebelstufe "Abschluss" einlegen | Zugbremshebel-/ventil direkt auf die "Abschluss"-Stellung stellen  
switch.toggle.front | Weiche voraus umstellen | Entspricht der Taste [G]  
switch.toggle.back | Weiche heckseitig umstellen | Entspricht der Taste [Shift]+[G]  
TrainProtSysReset | Zugsicherungssystem: Zurücksetzen | Zu betätigen, wenn eine Zwangsbremsung erfolgt ist, z.B. PZB90 "Frei" oder Fahrsperren-Taste bei der Berliner U-Bahn  
TrainProtSysConfirm | Zugsicherungssystem: Bestätigen | Zu betätigen, wenn eine kritische Situation bestätigt werden soll, z.B. PZB90 "Wachsam"  
TrainProtSysOverride | Zugsicherungssystem: Überbrücken | Überbrücken der Auslösung bei bewusstem Vorbeifahren z.B. an einem roten Signal - PZB90: "Befehl"  
|}

== 2.2  Bus-Steuerung  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
Bus.Throttle | Gaspedal |   
Bus.Brake | Bremspedal |   
Bus.SteeringLeft  
Bus.SteeringRight | Lenkrad links/rechts |   
Bus.SteeringNeutral | Lenkrad mittig |   
Bus.GearBoxMode_N  
| Getriebe Neutral  
| Automatikgetriebe: Fahrstufe Neutral einlegen  
manuelles Getriebe: kein Gang einlegen  
  
Bus.GearBoxMode_D | Getriebestufe D | (nur Automatikgetriebe)  
Bus.GearBoxMode_R | Getriebestufe R | (nur Automatikgetriebe)  
  
|   
|   
  
|}

== 2.3  Steuerung Bahn & Bus  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
ParkBrakeOn | Feststellbremse ein | Alle Arten von Feststellbremsen, die zum dauerhaften Bremsen und Abstellen des Fahrzeuges wie die Handbremse beim Auto, die KOM/Lkw-Feststellbremse, Federspeicherbremsen... Handelt es sich um ein Handrad, wird die Bremskraft kontinuierlich erhöht.  
ParkBrakeOff | Feststellbremse aus | Handelt es sich um ein Handrad, wird die Bremskraft kontinuierlich verringert.  
ParkBrakeToggle | Feststellbremse toggeln | Ist die Feststellbremse gelöst, wird sie aktiviert und umgekehrt. Handräder müssen nicht unterstützt werden  
ParkBrake2On, ...Off, ...Toggle | Sekundäre Feststellbremse | Selbe Wirkung wie bei der primären Feststellbremse.  
Im Falle von Kraftfahrzeugen mit Automatikgetriebe wird mit ParkBrake2Toggle die Fahrstufe "P" eingelegt  
Gear_0...  
Gear_6 | Getriebe Gang/Fahrstufe 0...6 | Kfz-Automatikgetriebe: Fahrstufe 1 bis 6 einlegen  
Kfz-manuelles Getriebe: Gang 1 bis 6 einlegen  
Schienenfahrzeug-Getriebe: Gang 0 bis 6 einlegen  
GearUp, GearDown | Getriebe Gang hoch-/runterschalten | Sowohl für Stufenschalter wie z.B. im Schienenbus als auch für Schaltwippen  
Clutch  
| Kupplung(spedal) |   
|}

  

== 2.4  Energieversorgung  ==

  

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
HighVoltageMainSwitchOn | Fahrstromschalter ein | Mit Hauptstromschalter sind alle Arten von Schalter/Schütze gemeint, die die gesamte Fahrelektrik vom Hochspannungskreis trennen und was auch durch eine Überlast-Einrichtung erfolgen kann  
HighVoltageMainSwitchOff | Fahrstromschalter aus |   
HighVoltageMainSwitchToggle | Fahrstromschalter toggeln |   
PantographUp | Stromabnehmer anheben/anlegen |   
PantographDn  
| Stromabnehmer senken/ablegen |   
ConverterOn | Umformerschalter ein | Umformer, der aus der hohen Spannung aus Fahrleitung oder Stromschiene die niedrige Steuerspannung bereit stellt.  
ConverterOff | Umformerschalter aus |   
ConverterToggle | Umformerschalter toggeln |   
  
|}

== 2.5  Lichter  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
IndicatorToLeft | Blinkerschalter Richtung links | Wird ggf. zuerst in die Neutralstellung gebracht  
IndicatorToRight | Blinkerschalter Richtung rechts | Wird ggf. zuerst in die Neutralstellung gebracht  
IndicatorToggleLeft | Blinkerschalter sofort links oder aus | Befindet sich der Blinkerschalter bereits in der "Links"-Stellung, wird er auf "Aus" gestellt. Ansonsten wird er direkt in die Stellung "Links" gestellt.  
IndicatorToggleRight | Blinkerschalter sofort rechts oder aus | Befindet sich der Blinkerschalter bereits in der "Rechts"-Stellung, wird er auf "Aus" gestellt. Ansonsten wird er direkt in die Stellung "Rechts" gestellt.  
IndicatorOff | Blinkerschalter sofort auf aus | Blinkerschalter wird direkt auf die "Aus"-Stellung gesetzt.  
IndicatorWarn | Warnblinker |   
FrontLightPlus | Außenlicht verstärken | Der Schalter für das Außenlicht wird (für gewöhnlich) von der Stellung "Aus" schrittweise über "Standlicht" auf "Abblendlicht" gestellt  
FrontLightMinus | Außenlicht verringern | Der Schalter für das Außenlicht wird (für gewöhnlich) von der Stellung "Abblendlicht" schrittweise über "Standlicht" auf "Aus" gestellt  
FrontLightOff | Außenlicht aus |   
FrontLightPark | Standlicht |   
FrontLightDim | Abblendlicht  
|   
FrontLightFull | Fernlicht |   
FrontLightDaytime | Tagfahrlicht |   
FrontLightFogToggle | Nebelscheinwerfer ein/aus |   
RearFogLightToggle | Nebelschlussleuchte ein/aus |   
|}

== 2.6  Signalanlagen  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
Bell1 | Klingel 1 | Hauptsächlich bzw. standardmäßig verwendete Klingel  
Bell2 | Klingel 2 | Zusätzliche Klingel  
Horn1 | Hupe/Pfeife/Horn/Makrophon 1 | Hauptsächlich bzw. standardmäßig verwendetes Signal  
Horn2 | Hupe/Pfeife/Horn/Makrophon 2 | Zusätzliches Signal  
|}

== 2.7  Türen  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
DoorReleaseOn | Türfreigabe geben | Nur für Fahrzeuge _ohne_ seitenselektiver Freigabe, d.h. bei Einrichtungsfahrzeugen oder bei Fahrzeugen mit Seiten-Vorwahl (vgl. DoorSideToggle) bzw. bei Fahrzeugen, bei denen grundsätzlich nur alle Türen gleichzeitig freigegeben werden können (z.B. alte U-Bahnwagen)  
DoorReleaseLeft | Türfreigabe links geben | Nur für Fahrzeuge mit seitenselektiver Freigabe, d.h. keine Einrichter und nur Fahrzeuge, bei denen unabhängig voneinander und ohne Seitenvorwahl auch beide Seiten freigegeben werden können.  
DoorReleaseRight | Türfreigabe rechts geben | dito  
DoorReleaseOff | Türfreigabe zurücknehmen |   
DoorReleaseToggle | Türfreigabe toggeln | Gilt nur für Fahrzeuge, die auch DoorReleaseOn unterstützen.  
DoorAllOpen | Zwangsöffnen |   
DoorAllClose | Zwangsschließen |   
Door1Toggle | Tür 1 toggeln |   
Door1Open | Tür 1 öffnen |   
Door1Close | Tür 1 schließen |   
Door1Wing2Toggle | Tür 1, zweiten Türflügel toggeln |   
Door1Wing2Open | Tür 1, zweiten Türflügel öffnen |   
Door1Wing2Close | Tür 1, zweiten Türflügel schließen |   
DoorSideToggle | Türöffnungs-Seite wechseln | Wechsel der Seite für die Türfreigabe  
DoorSideLeft | Türöffnungs-Seite auf links |   
DoorSideRight | Türöffnungs-Seite auf rechts |   
DoorSideBoth | beide Türöffnungs-Seiten auswählen |   
KneelingUp | Kneeling-Funktion aus / hoch |   
KneelingDown | Kneeling-Funktion an / ab |   
KneelingToggle | Kneeling-Funktion toggeln |   
DoorStepPlattformHigh | Türstufen für hohe Bahnsteige | Für Fahrzeuge mit variabler Trittstufenhöhe. Die Trittstufen werden für den Einstieg von einem bzw. Ausstieg auf einen hohen Bahnsteig vorgewählt.  
DoorStepPlattformLow | Türstufen für niedrige Bahnsteige | Für Fahrzeuge mit variabler Trittstufenhöhe. Die Trittstufen werden für den Einstieg von einem bzw. Ausstieg auf einen niedrigen Bahnsteig vorgewählt.  
DoorStepStreet | Türstufen für Straße | Für Fahrzeuge mit variabler Trittstufenhöhe. Die Trittstufen werden für den Einstieg von der bzw. Ausstieg auf die Straße vorgewählt.  
WheelchairLiftUp | Hublift heben |   
WheelchairLiftDown | Hublift senken |   
|}

== 2.8  Fahrerraum  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
WiperToggle | Scheibenwischer ein/aus |   
WiperLeftToggle | Linker Scheibenwischer ein/aus |   
WiperRightToggle | Rechter Scheibenwischer ein/aus |   
WiperPlus | Scheibenwischer Stufe höher stellen |   
WiperMinus | Scheibenwischer Stufe zurück stellen |   
DriverHeaterToggle | Fahrerraumheizung |   
FrontWindowHeaterToggle | Frontscheibenheizung |   
MirrorLeft | Linken Außenspiegel ein- oder ausklappen |   
MirrorRight | Rechten Außenspiegel ein- oder ausklappen |   
CockpitLightPlus | Fahrerraumlicht einschalten |   
CockpitLightMinus | Fahrerraumlicht ausschalten |   
CockpitLightToggle | Fahrerraumlicht ein-/ausklappen |   
|}

  

== 2.9  Linien- und Zielanzeigen  ==

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
DisplaySel1 ... DisplaySel4 | Anzeige 1 bis 4 auswählen | ... um diese mit den anderen Events zu verstellen  
DisplayMoveSelUp | Bewegt/Verstellt die ausgewählte Anzeige aufsteigend | ... hin zu höheren Ziel-Indizes  
DisplayMoveSelDn | Bewegt/Verstellt die ausgewählte Anzeige absteigend | ... hin zu niedrigeren Ziel-Indizes  
DisplayMove1Up ... DisplayMove4Up | Bewegt/Verstellt Anzeige 1...4 aufsteigend | ... hin zu höheren Ziel-Indizes  
DisplayMove1Dn ... DisplayMove4Dn | Bewegt/Verstellt Anzeige 1...4 absteigend | ... hin zu niedrigeren Ziel-Indizes  
|}

  

== 2.10  "Bordcomputer"  ==

Als Bordcomputer ist hier etwas umgangssprachlich jede Art von Gerät gemeint, welches der primären Ein- und Ausgabe von elektronischen, digitalen Daten dient, die insbesondere für die Kommunikation, dem [[https://www.lotus-simulator.de/lexikon/index.php?entry/155-fis/&synonym=126|FIS]] und/oder der Ausgabe von Fahrkarten dient. Typische Beispiele sind IBIS, RBL, Fahrkarten-Drucker usw.

  

Die meiner Meinung nach internationalste und allgemeinste Sammelbezeichnung ist ITCS, "Intermodal Transport Control System", weshalb ich diese als Präfix nutze.

  

{| class="wikitable"  ID | Kurzbezeichnung | Ergänzende Informationen  
---|---|---  
ITCSEnter | Eingabetaste |   
ITCSCancel | Abbruch-Taste |   
ITCS0...ITCS9 | Numerische Tasten 0 bis 9 |   
ITCSPlus | Plus-Taste |   
ITCSStar | Sternchen-Taste |   
ITCSNext / ITCSPrev | Pfeiltasten zum Durchschalten von Menüs o.Ä. |   
ITCSFunction | Funktionsaufruf-Taste |   
ITCSLine | "Linie"-Taste |   
ITCSRoute | "Route"-Taste |   
ITCS ??? | "Kurs"-Taste |   
ITCSTerminus | "Ziel"-Taste |   
ITCSTimeDate | Uhrzeit/Datum-Taste |   
ITCSEmergencyCall | Unfall-Ruf-Taste |   
ITCSCall | Ruf-Taste / Sprechwunsch |   
ITCSPriorityCall | Ruf mit Priorität |   
ITCSDepotCall | Ruf Hof-Einsatzleitung |   
ITCSCloseRangeCall | Nahbereichs-Ruf |   
ITCSNextStop | Weiterschalten zur nächsten Haltestelle inkl. Ansage |   
ITCSNextStopMute | Weiterschalten zur nächsten Haltestelle ohne Ansage |   
ITCSPrevStop | Zurückschalten zur vorherigen Haltestelle inkl. Ansage |   
ITCSPrevStopMute | Zurückschalten zur vorherigen Haltestelle ohne Ansage |   
ITCSAnnouncementStop | Ansage stoppen |   
ITCSTicket0, 1, 2... | Auswahltasten für Fahrscheindruck |   
ITCSSwitchLeft | Weiche links |   
ITCSSwitchStraight | Weiche geradeaus |   
ITCSSwitchRight | Weiche rechts |   
ITCSSignalRequest | Ampel-/Signalanforderung |   
ITCSAnnounceEnter | Ansage "Einsteigen bitte" |   
ITCSAnnounceStandClear | Ansage "Zurückbleiben bitte!" |   
|}

  

== 3  Gamecontroller-Achsen  ==

== 3.1  Fahrzeugsteuerung  ==

{| class="wikitable"  ID | Kurzbezeichnung | Richtung | Ergänzende Informationen  
---|---|---|---  
Throttle | Gaspedal, Schubhebel | 0 = kein Gas  
1 = Vollgas | Dient der Ansteuerung über eine reine Schub-/Gaspedal-Achse. Kombihebel sollten aber auch hierauf reagieren.  
Brake | Bremshebel, Bremspedal | 0 = keine Bremskraft  
1 = Schnellbremse | Dient der Ansteuerung über eine reine Bremspedal/-hebel-Achse. Kombihebel sollten aber auch hierauf reagieren. Die Achse sollte im Maximum _eine_ Schnellbremsung einleiten.  
BrakeWithoutMax | Bremshebel, Bremspedal ohne Schnellbremse | 0 = keine Bremskraft  
1 = Stärkste Normalbremsung | Dient der Ansteuerung über eine reine Bremspedal/-hebel-Achse. Kombihebel sollten aber auch hierauf reagieren. Die Achse sollte im Maximum _keine_ Schnellbremsung einleiten.  
ThrottleBrake | Gas-Brems-Kombination | 0 = Schnellbremse  
0,5 = Neutral  
1 = Vollgas | Dient vor allem der Ansteuerung eines Kombi-Sollwertgebers. Einzelpedale/-Hebel sollten jedoch auch hierauf reagieren. Die Achse sollte im Minimum _eine_ Schnellbremse einleiten.  
ThrottleBrakeWithoutMax | Gas-Brems-Kombination ohne Schnellbremse | 0 = Stärkste Normalbremsung  
0,5 = Neutral  
1 = Vollgas | Dient vor allem der Ansteuerung eines Kombi-Sollwertgebers. Einzelpedale/-Hebel sollten jedoch auch hierauf reagieren. Die Achse sollte im Minimum _keine_ Schnellbremse einleiten.  
|}