Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- stellwerksim:erbauer:themascripte:hooks [2019/01/20 12:38] – wording petero
+++ stellwerksim:erbauer:themascripte:hooks [2021/04/14 16:08] (aktuell) – Regions-Zuordnung ThemaScripte DevonFrosch
@@ Zeile 1: / Zeile 1: @@
 {{indexmenu_n>60}}
-==== Die Hooks ====
+====== Die Hooks ======
-Hooks erlauben es, recht flexibel eigenen Code, welcher dann für eine ganze Region gilt, in generelle Scripte einzubauen. Dazu muss im generellen Script nur ein Hook-Aufruf vorhanden sein. Sollte kein passendes Script gefunden werden, wird der Befehl übersprungen.
+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.
 <note>Für <NAME> kann ein beliebiger Text eingegeben werden.\\
 Für <REGION> wird ein Regionskürzel eingesetzt.</note>
 ^ Befehl ^ Region ^ Parameter ^ Name des aufgerufenen ThemaScripts ^
-| hook | Region des Zug-Templates | <NAME>,hook | ZH-<REGION>-<NAME> |
+| 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 Zug-Template bzw. die Anlage in welchem sich der Zug gerade befindet zu der übergebenen Region gehört.
+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 Zug-Templates | <NAME>,<THEMA>,regionhook | ZH-<REGION>-<NAME> |
+| thook | Region des Zugtemplates | <NAME>,<THEMA>,regionhook | ZH-<REGION>-<NAME> |
-| tregionhook | Region der Anlage| <NAME>,<THEMA>,tregionhook | RH-<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.
 <note verbot>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.</note>
-Hooks sind im Standardscript bereits eingebaut. Folgende Namen (In den obigen Tabellen als <NAME> gekennzeichnet) können dabei für das aufzurufende ThemaScript vergeben werden.
+Hooks sind im Standardscript bereits eingebaut. Folgende Namen können dabei für das aufzurufende ThemaScript vergeben werden:
-^ NAME ^ Hinweis ^
+^ Name ^ Hinweis ^
-| stdstarthook | Befehle aus dem Hook werden von Befehlen aus dem Standardscript überschrieben. |
+| ZH-<REGION>-stdstarthook | Befehle aus dem Hook werden von Befehlen aus dem Standardscript überschrieben. |
-| stdreghook | Befehle aus dem Regionhook werden von Befehlen aus dem Standardscript überschrieben. |
+| RH-<REGION>-stdreghook | Befehle aus dem Regionhook werden von Befehlen aus dem Standardscript überschrieben. |
-| stdendhook | Befehle aus dem Hook überschreiben die Befehle aus dem Standardscript. |
+| ZH-<REGION>-stdendhook | Befehle aus dem Hook überschreiben die Befehle aus dem Standardscript. |
-<note>Es wird nur ein ThemaScript mit dem jeweiligen Namen aufgerufen. Hat es mehrere aufzurufende ThemaScripte mit dem selben Namen und der selben Region werden nach dem ersten gefundenen alle weiteren ignoriert.</note>
+<note>Hooks sollten der Region zugeordnet sein, zu der sie gehören. Außerdem muss der Name des Scripts über alle Regionen hinweg einzigartig sein.</note>
 {{tag>ThemaScript}}

STS Handbuch

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge