Szenario Skripting

INFORMATION:
Das Meiste des folgenden ist nicht ausreichend dokumentiert.
alle Informationen setzen sich aus offiziellen, inoffiziellen und meinen Erkenntnissen zusammen.
Alle Inhalte ohne Gewähr.
Inhalt und Richtigkeit kann sich jederzeit ändern, da es sich nicht um kein offizielles Dokument handelt.

Ergänzung wird in Kürze folgen.
Beispiele werden ebenfalls folgen.
Für einen kleinen Überblick, siehe hier.

== Grundlegendes ==

Ereignisse
"Events"
- werden durch Erfolg oder Misserfolg einer Anweisung oder den Abschluss eines Triggers ausgelöst
- in der Fahrplan Ansicht können sie in den Feldern "Erfolgsbedingung", "Auslösen Erfolg" und "Auslösen Fehler" verwendet werden
"DefferedEvents"
- können auch durch einen Skriptaufruf durch die Funktion "TriggerDeferredEvent" ausgelöst werden (dazu später)

- Ereignisse, deren Auslösung nach einem festgelegten Intervall erfolgt
- Sie sind der Mechanismus, um das gesamte Timing durchzuführen, wenn sie mit einem Spiel gespeichert werden

Bedingungen
- Testen von zusätzlichen Anforderungen an den Spieler, wenn eine Anweisung ansonsten erfolgreich wäre
- Zum Beispiel kann für eine "Gehe über"-Anweisung eine Bedingung getestet werden, wenn der Zug in die Markierung einfährt
- Bedingungen können zu einer Anweisung im Feld "Erfolgsbedingung" hinzugefügt werden
- Bedingungen können auch durch einen Aufruf der Skriptfunktion "BeginConditonCheck" getestet werden (dazu später)
- Überprüfte Bedingungen sind eine Möglichkeit zu testen, ob eine Bedingung über einen bestimmten Zeitraum beibehalten wird z.B.: Druck
- Sobald eine Bedingung abgeschlossen ist, wird ihr Wert gespeichert und alle weiteren Überprüfungen geben diesen gespeicherten Wert zurück.

Szenarioskript
- ein ScenarioScript.lua muss im Stammverzeichnis des Szenarios platziert werden
- Diese sollte zwei Funktionen definieren:

- mit "function OnEvent ( event )" werden alle Ereignisaufrufe aus dem Szenariosystem verarbeitet
- TRUE (1), wenn das Ereignis behandelt wird
- FALSE (0), wenn das Ereignis unbekannt ist
- "event" Name des Ereignisses, wie in der Anweisung, dem Trigger oder dem "TriggerDeferredEvent" definiert

- mit "function TestCondition ( condition )" wird getestet, ob der Spieler zusätzliche Bedingungen für eine Anweisung erfüllt hat
- CONDITION_NOT_YET_MET (0), CONDITION_SUCCEEDED (1) oder CONDITION_FAILED (2) zurückgeben
- "condition" Name der Bedingung, wie in der Anweisung oder in "BeginConditonCheck" definiert

- Szenarioskripte haben eine andere Aufrufkonvention als andere Skripte im Spiel
- Statt Call, verwendet das Szenario Skript "SysCall"
"SysCall" hat Zugriff auf eine Reihe globaler Funktionen, sowie auf die normalen Skriptfunktionen aller benannten Objekte
"SysCall" verwendet eine Doppelpunktnotation, um das Objekt oder das Modul zu beschreiben, für das der Funktionsaufruf erforderlich ist z.B.:
SysCall ( "ScenarioManager:ShowMessage", "Title", "Message" )
richtung = SysCall ( "PlayerEngine:GetControlValue", "Regulator" );
Eine zweite Doppelpunktnotation kann verwendet werden, um ein untergeordnetes Objekt abzurufen z.B.:
SysCall ( "PlayerEngine:Main Smoke Stack:GetEmitRate" )

- Jedes in einem Szenario platzierte Objekt kann im Eigenschaften-Flyout im Feld " Objektname " benannt werden.
- PlayerEngine ist ein besonderer Wert, dieser bezieht sich immer auf die "PlayerEngine".
- Auch jedes nummerierte Schienenfahrzeug kann verwendet werden.

Wichtig:
Es ist zu empfehlen, jegliches Scripting mit einem geeigneten Text-Editor durchzuführen (Notepad++, LuaEdit, etc.)
Zustände in Szenarioskripten werden bei Speichern und Fortsetzen des Szenarios nicht beibehalten

== Funktionen ==

Szenario Manger:

TriggerScenarioComplete

TriggerScenarioFailure

TriggerDeferredEvent

CancelDeferredEvent

BeginConditionCheck

EndConditionCheck

GetConditionStatus

ShowMessage

ShowInfoMessageExt

ShowAlertMessageExt