Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- stellwerksim:plugins:spezifikation [2016/04/05 15:09] – [Spezifikation] Fehlercode 403 hinzugefügt DLichti
+++ stellwerksim:plugins:spezifikation [2024/12/28 15:05] (aktuell) – Rechtschreibfehler korrigiert BeiLen
@@ Zeile 1: / Zeile 1: @@
-===== Spezifikation =====
+===== Spezifikation der Pluginschnittstelle =====
 {{indexmenu_n>30}}
@@ Zeile 5: / Zeile 5: @@
 Nach dem Connect meldet sich der Sim mit dem Status-XML:
 <code>
-<status code="300">ein Text</status>
+<status code='300' >STS Plugin Interface, bitte anmelden.</status>
 </code>
@@ Zeile 21: / Zeile 21: @@
 ===== Befehle =====
+Parameter sind immer erforderlich, außer es steht (optional) dahinter. Die Ausgabe ist teilweise eingerückt, damit sie besser lesbar ist.
 ==== <register> ====
-Registriert einen Client, als Werte müssen mitgegeben werden:
+Registriert einen Client.
+Parameter:
   * name: Name des Clients
   * autor: Autor des Clients
@@ Zeile 31: / Zeile 35: @@
 Beispiel:
 <code>
-<register name="Supersuper" autor="der Held" version="0.1alpha-nix" protokoll="1" text="Tut nix!" />
+<register name='Supersuper' autor='der Held' version='0.1alpha-nix' protokoll='1' text='Tut nix!' />
+</code>
+Antwort:
+<code>
+<status code='220' >Ok.</status>
 </code>
@@ Zeile 37: / Zeile 46: @@
 ==== <simzeit> ====
-Erfragt die Sim-Zeit. Der übergebene Parameter "sender" wird wieder zurückgesendet, außerdem ein Parameter "zeit" mit der Simzeit in Millisekunden seit 0 Uhr. Als "sender" schickt man beim Absenden die aktuelle Zeit auf dem Client. Bekommt man dann die Antwort kann man aus der aktuellen Zeit und der Zeit vom Versand die Übertragungsdauer ermitteln. Grob aber ausreichend genau ist dann die Hälfte der Differenz zur übertragenen Sim-Zeit zu addieren um eine hinreichend genaue Zeit zu haben. Es ist zweckmäßig die Zeit dann selbst zu speichern und weiterzuzählen.
+Erfragt die Sim-Zeit. Als 'sender' schickt man beim Absenden die aktuelle Zeit auf dem Client. Bekommt man dann die Antwort kann man aus der aktuellen Zeit und der Zeit vom Versand die Übertragungsdauer ermitteln. Grob aber ausreichend genau ist dann die Hälfte der Differenz zur übertragenen Sim-Zeit zu addieren um eine hinreichend genaue Zeit zu haben. Es ist zweckmäßig die Zeit dann selbst zu speichern und weiterzuzählen.
+Parameter:
+  * sender: Wird wieder zurückgesendet
+Antwort:
+  * sender: Wert aus der Anfrage
+  * zeit: Simzeit in Millisekunden seit 0:00 Uhr
+Beispiel:
+<code>
+<simzeit sender='28908598' />
+</code>
+Antwort:
+<code>
+<simzeit sender='28908598' zeit='28908601' />
+</code>
 ==== <anlageninfo> ====
-Keine Parameter, liefert Name ("name") des Stellwerks, AID ("aid") und Build des Sims ("simbuild").
+Liefert Name ('name') des Stellwerks, AID ('aid') und Build des Sims ('simbuild'). Außerdem, ob ein Online-Spiel läuft oder in der Sandbox gestartet wurde.
+Parameter: Keine
+Beispiel:
+<code>
+<anlageninfo />
+</code>
+Antwort:
+<code>
+<anlageninfo simbuild='1' name='Plugin Test Anlage' aid='86' region='Testregion' online='True'/>
+</code>
 ==== <bahnsteigliste> ====
-Keine Parameter, liefert eine Liste alle Bahnsteige und deren Nachbarbahnsteige. Die Rückgabe enthält den Befehlstag als Eröffnung.
+Liefert eine Liste alle Bahnsteige und deren [[stellwerksim:erbauer:anlagen:gleiseditor:elemente:bahnsteig#nachbarbahnsteige|Nachbarbahnsteige]].
-Beispielausgabe:
+Parameter: Keine
+Beispiel:
 <code>
-<bahnsteigliste>
+<bahnsteigliste />
-<bahnsteig name="MMM1"><n name="MMM2" /><n name="MMM3" /></bahnsteig>
+</code>
-<bahnsteig name="MMM2"><n name="MMM1" /><n name="MMM3" /></bahnsteig>
-<bahnsteig name="MMM3"><n name="MMM1" /><n name="MMM3" /></bahnsteig>
+Antwort:
+<code>
+<bahnsteigliste >
+  <bahnsteig name='1' haltepunkt='false'>
+    <n name='2' />
+    <n name='3' />
+  </bahnsteig>
+  <bahnsteig name='2' haltepunkt='true'>
+    <n name='1' />
+  </bahnsteig>
+  <bahnsteig name='3' haltepunkt='false'>
+    <n name='1' />
+  </bahnsteig>
 </bahnsteigliste>
 </code>
 ==== <zugliste> ====
-Keine Parameter, liefert eine Liste alle Züge im Fahrplan. Die Rückgabe enthält den Befehlstag als Eröffnung.
+Liefert eine Liste aller Züge im Fahrplan.
-Beispielausgabe:
+Parameter: Keine
+Beispiel:
+<code>
+<zugliste />
+</code>
+Antwort:
 <code>
 <zugliste>
-<zug zid="1" name="RE 10" />
+  <zug zid='1' name='RE 10' />
-<zug zid="2" name="IC 3" />
+  <zug zid='2' name='IC 3' />
 </zugliste>
 </code>
 ==== <zugdetails> ====
-ZID als Parameter, liefert Details zum Zug. Die Rückgabe enthält den Befehlstag als Eröffnung. Es wird das nächste anzufahrende Gleis mitgeliefert, sowie die Namen der Ein- und Ausfahrt. Die Sichtbarkeit gibt an, ob der Zug im Gleisbild unterwegs ist oder noch nicht. Der Unterschied zwischen "gleis" und "plangleis" ist bei Gleisänderungen relevant: "plangleis" ist immer das Gleis, zu dem der Zug laut Fahrplan soll. "gleis" ist das Gleis nach einen Gleisänderung oder bei einem Zughalt der Gleis, an dem der Zug tatsächlich steht. "amgleis" ist true, wenn der Zug genau zum Zeitpunkt der Abfrage am Bahnsteig steht.
+Liefert Details zum Zug. Die Antwort liefert das nächste anzufahrende Gleis, sowie die Namen der Ein- und Ausfahrt. Die Sichtbarkeit gibt an, ob der Zug im Gleisbild unterwegs ist oder noch nicht. Der Unterschied zwischen 'gleis' und 'plangleis' ist bei Gleisänderungen relevant: 'plangleis' ist immer das Gleis, zu dem der Zug laut Fahrplan soll, 'gleis' ist das Gleis nach einen Gleisänderung oder bei einem Zughalt der Gleis, an dem der Zug tatsächlich steht. 'amgleis' ist true, wenn der Zug genau zum Zeitpunkt der Abfrage am Bahnsteig steht.
-Wurde der letzte Fahrplanhalt passiert, es somit keine anzufahrenden Gleise mehr gibt, werden die Attribute "gleis" und "plangleis" nicht mehr mitgeschickt. So lässt sich erkennen, ob ein Zug den letzten Fahrplanhalt passiert hat.
+Wurde der letzte Fahrplanhalt passiert und es somit keine anzufahrenden Gleise mehr gibt, werden die Attribute 'gleis' und 'plangleis' nicht mehr mitgeschickt. So lässt sich erkennen, ob ein Zug den letzten Fahrplanhalt passiert hat. Umgeleitete Züge haben ebenfalls kein 'gleis' und 'plangleis', da sie keinen Fahrplan haben.
-Umgeleitete Züge haben ebenfalls kein "gleis" und "plangleis", da sie keinen Fahrplan haben!
+Zusatztexte (freier Text) stehen in 'usertext' und 'hinweistext'.
-Beispielausgabe:
+Parameter:
+  * zid: ZID aus der Zugliste
+Beispiel:
+<code>
+<zugdetails zid='1' />
+</code>
+Antwort:
 <code>
-<zugdetails zid="1" name="RE 10" verspaetung="+2" gleis="MMM1" plangleis="MMM1" von="A-Stadt" nach="B-Hausen" sichtbar="true" amgleis="true"/>
+<zugdetails zid='1' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' usertext='' usertextsender='' hinweistext='' />
 </code>
 ==== <zugfahrplan> ====
-ZID als Parameter, liefert den restlichen Fahrplan zum Zug. Die Rückgabe enthält den Befehlstag als Eröffnung. Es wird das nächste anzufahrende Gleis mitgeliefert und alle folgenden, alle laut Fahrplan. Außerdem die Flags im modernen Flag-Syntax des STS.
+Liefert den restlichen Fahrplan zum Zug. Es wird das nächste anzufahrende und alle folgenden Gleise geliefert, mit Fahrplanzeiten und [[stellwerksim:erbauer:zugbau:flags|Flags]]. Umgeleitete Züge haben keinen Fahrplan, es wird eine leere Liste gesendet.
-Umgeleitete Züge haben keinen Fahrplan, d.h. er wird hier eine leere Liste gesendet.
+Parameter:
+  * zid: ZID aus der Zugliste
-Beispielausgabe:
+Beispiel:
+<code>
+<zugfahrplan zid='1' />
+</code>
+Antwort:
 <code>
-<zugfahrplan zid="1">
+<zugfahrplan zid='1'>
-<gleis plan="MMM1" name="MMM1" an="08:10" ab="08:12" flags="" />
+  <gleis plan='1' name='1' an='08:10' ab='08:10' flags='D' />
 </zugfahrplan>
 </code>
@@ Zeile 95: / Zeile 168: @@
   * abfahrt
   * ausfahrt
+  * rothalt
+  * wurdegruen
+  * kuppeln
+  * fluegeln
 Möchte man alle haben, müssen entsprechend viele Registrierungen abgeschickt werden. Man muss sich für jeden Zug neu registrieren, mehrmaliges Registrieren für den selben Zug ist nicht zulässig! Die Meldung eines Ereignisses enthält die ZID, die Art sowie alle Daten, die auch per <zugdetails> geliefert werden. Im Falle eines D-Flags wird nur die Ankunft gemeldet, jedoch keine Abfahrt.
+Beispiel:
+<code>
+<ereignis zid='1' art='einfahrt' />
+</code>
+Antwort:
+<code>
+<ereignis zid='1' art='einfahrt' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' />
+</code>
+==== <wege> ====
+Liefert eine Liste aller Knoten und Verbindungen des Gleisbild. Daraus sind die Fahrwege von Einfahrten zu Bahnsteigen zu Bahnsteigen zu Ausfahrten ermittelbar.
+Knoten sind dabei Gleiselemente wie Signale, Einfahrten, Ausfahrten und Bahnsteige. Diese haben entweder eine ENR oder einen Namen (Bahnsteige haben nur Namen). Die Verbindungen haben entweder 2 ENRs, ENR und Name oder 2 Namen. Das sind dann die Verbindungen zwischen 2 Knoten. Bahnsteige haben nur Namen, alle anderen haben ENRs.
+Beispiel:
+<code>
+<wege />
+</code>
+Antwort:
+<code>
+<wege>
+  <shape type='6' name="Ein1" enr="1" />
+  <shape type='7' name="Aus1" enr="2" />
+  <connector enr1="1" enr2="2" />
+</wege>
+</code>
+==== <stitz> ====
+Liefert die StiTz-Rufnummern für den Regionsraum und den allgemeinen Spielerraum.
+Beispiel:
+<code>
+<stitz />
+</code>
+Antwort:
+<code>
+<stitz region='81031' allgemein='77114' />
+</code>

STS Handbuch

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge