Handbuch

STS Handbuch

Stellwerksim Handbuch

Webseiten-Werkzeuge


Seitenleiste



JavaScript ist deaktiviert!

stellwerksim:erbauer:themascripte:hooks

Die Hooks

Hooks erlauben es, den Zügen einer Region flexibel Code einzufügen, ohne das dem Zugtemplate zugeordnete ThemaScript anpassen zu müssen. Dazu muss im Script des Zugtemplates (oder einem eingebundenen Script) nur ein Hook-Aufruf vorhanden sein. Sollte kein passendes Script gefunden werden, wird der Befehl übersprungen.

Für <NAME> kann ein beliebiger Text eingegeben werden.
Für <REGION> wird ein Regionskürzel eingesetzt.
Befehl Region Parameter Name des aufgerufenen ThemaScripts
hook Region des Zugtemplates <NAME>,hook ZH-<REGION>-<NAME>
regionhook Region der Anlage <NAME>,regionhook RH-<REGION>-<NAME>

Hier wird jeweils das ganze ThemaScript aufgerufen, wenn das Zugtemplate bzw. die Anlage in welchem sich der Zug gerade befindet zu der übergebenen Region gehört.

Befehl Region Parameter Name des aufgerufenen ThemaScripts
thook Region des Zugtemplates <NAME>,<THEMA>,regionhook ZH-<REGION>-<NAME>
tregionhook Region der Anlage <NAME>,<THEMA>,tregionhook RH-<REGION>-<NAME>

Bei diesen beiden Befehlen werden jeweils nur die für das übergebene Thema relevanten Blocks aufgerufen.

In einem Hook darf niemals ein sub eingebunden werden, welcher auf ein Script verweist, welches selber schon ein Hook enthält. Dies gilt insbesondere für das Standard-ThemaScript(1) oder ein anderes ThemaScript, welches auf das Standard-ThemaScript verweist.

Hooks sind im Standardscript bereits eingebaut. Folgende Namen können dabei für das aufzurufende ThemaScript vergeben werden:

Name Hinweis
ZH-<REGION>-stdstarthook Befehle aus dem Hook werden von Befehlen aus dem Standardscript überschrieben.
RH-<REGION>-stdreghook Befehle aus dem Regionhook werden von Befehlen aus dem Standardscript überschrieben.
ZH-<REGION>-stdendhook Befehle aus dem Hook überschreiben die Befehle aus dem Standardscript.
Hooks sollten der Region zugeordnet sein, zu der sie gehören. Außerdem muss der Name des Scripts über alle Regionen hinweg einzigartig sein.
stellwerksim/erbauer/themascripte/hooks.txt · Zuletzt geändert: 2021/04/14 16:08 von DevonFrosch