CommonAPI in ein Mod einbauen/nachrüsten
1 CommonAPI in ein Mod einbauen/nachrüsten
Wichtig: Baut eure Mods immer so, das eure Mods auch ohne die CommonAPI funktioniert. Um herauszufinden ob die CommonAPI geladen ist, überprüft die globale Variable [tt]commonapi[/tt]
Beispiel:
[code]if (commonapi ~= nil) then
-- Wird nur ausgeführt wenn die CommonAPI vorhanden ist
end
-- In der Regel müsst Ihr Unterfunktionen auch testen:
if (commonapi ~= nil and commonapi.uiparameter ~= nil) then
end[/code]
2 Gleisauswahl
Die CommonAPI bietet euch die Möglichkeit an, alle vom Nutzer aktivierten Gleise abzufragen und auch in eurer Konstruktion anzuzeigen.
Die einfachste Möglichkeit solltet ihr eine Liste mit trackTypes und eure ui parameter dafür definiert haben, diese durch [tt]commonapi.uiparameter.modifyTrackCatenary([/tt] modifizieren zu lassen.
commonapi.uiparameter.modifyTrackCatenary([color=#FF0000]params[/color], [color=#008000]{[/color]
[color=#FFA500][b]selectionlist [/b][/color]= config.trackTypes
[color=#006400]}[/color])
Der Aufruf dieser Funktion verursacht:
[list][*]Interne Erstellung eines TrackCatenarySelector mit den optionalen Parametern [color=#006400](grün)[/color]
[*]Die Modifikation der config.trackTypes [color=#FFA500](orange)[/color]
[*]Änderung der params [color=#FF0000](rot)[/color]
[/list]Solltet Ihr eure Oberleitung oder Gleisauswahl nicht trackType und catenary nennen, so könnt Ihr in den [color=#006400]optionalen Parametern[/color] diese mit [tt]key = "trackType", catenary_key = "catenary",[/tt] ggf. anpassen.
Bitte beachtet, jede Referenz zur einer Liste, die Ihr via [color=#FFA500][b]selectionlist[/b][/color] übergibt muss eindeutig sein und darf nicht von einem anderen Parameter mit genutzt werden.
Solltet Ihr mehr als ein trackType (Beispiel Überholgleis) in eurer Konstruktion unterstützen, so muss auch eine Referenz zur eine neuen Liste von Gleistypen angeben werden
[code=lua]commonapi.uiparameter.modifyTrackCatenary(params, {
key = "trackType2",
catenary_key = "catenary2",
selectionlist = config.trackTypes2
})[/code]
3 Weiterführende Informationen:
[url='https://www.transportfever.net/filebase/index.php/Entry/3287-Common-API/']CommonAPI in der Webdisk[/url]
[url='https://www.transportfever.net/index.php/Thread/9110-Common-API/']CommonAPI Forum Beitrag[/url]
Eine komplette API Dokumentation findet Ihr im doc Ordner in der CommonAPI.
Kommentare
Neu erstellte Kommentare unterliegen der Moderation und werden erst sichtbar, wenn sie durch einen Moderator geprüft und freigeschaltet wurden.
Neu erstellte Kommentare unterliegen der Moderation und werden erst sichtbar, wenn sie durch einen Moderator geprüft und freigeschaltet wurden.
Volvo EG
Hi,
ich hab quasi keinen Plan von Modding an sich, würde aber gerne die normale Spitzkehre sowie einen anderen Bahnhof so nachrüsten, dass ich alle Gleise auswählen kann. Aus dem oben beschriebenen Vorgehen, entstehen bei mir viele Fragezeichen. Wo muss ich von den oben genannten Dingen was einfügen? In welche Dateien? Wäre super, wenn mir das jemand erklären könnte, denn ich weiß, dass ich damit mein Problem (s. hier) lösen kann und dann nicht immer irgendwo Weichen einbauen muss, damit die normalen Gleise nicht mir den Unterbau verhässlichen.
Vielen Dank
Volvo