CommonAPI Unterstützung einbauen/nachrüsten

[h1]CommonAPI in ein Mod einbauen/nachrüsten[h1]

1 Ist CommonAPI geladen?

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. [info=warning]Bitte beachtet: Eine Liste, die via [color=#FFA500][b]selectionlist[/b][/color] übergeben wird 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[/info] [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.