CommonAPI Unterstützung einbauen/nachrüsten

Willkommen in der Transport Fever Community

Welcome to the fan community of Transport Fever and Train Fever, the economic simulators of Urban Games. The community is free for you to share and inform yourself about the game. We cultivate a friendly and objective interaction with each other and our team will be happy to answer any questions you may have.

 

Registration and use is of course free for you.

 

We wish you a lot of fun and hope for active participation.

The Team of the Transport-Fever Community

  • CommonAPI in ein Mod 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 commonapi


    Beispiel:

    Code
    1. if (commonapi ~= nil) then
    2. -- Wird nur ausgeführt wenn die CommonAPI vorhanden ist
    3. end
    4. -- In der Regel müsst Ihr Unterfunktionen auch testen:
    5. if (commonapi ~= nil and commonapi.uiparameter ~= nil) then
    6. end

    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 commonapi.uiparameter.modifyTrackCatenary modifizieren zu lassen.


    commonapi.uiparameter.modifyTrackCatenary(params, {
    selectionlist = config.trackTypes
    })


    Der Aufruf dieser Funktion verursacht:

    • Interne Erstellung eines TrackCatenarySelector mit den optionalen Parametern (grün)
    • Die Modifikation der config.trackTypes (orange)
    • Änderung der params (rot)

    Solltet Ihr eure Oberleitung oder Gleisauswahl nicht trackType und catenary nennen, so könnt Ihr in den optionalen Parametern diese mit key = "trackType", catenary_key = "catenary", ggf. anpassen.


    [info=warning]Bitte beachtet:
    Eine Liste, die via selectionlist ü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
    1. commonapi.uiparameter.modifyTrackCatenary(params, {
    2. key = "trackType2",
    3. catenary_key = "catenary2",
    4. selectionlist = config.trackTypes2
    5. })



    3 Weiterführende Informationen


    CommonAPI in der Webdisk
    CommonAPI Forum Beitrag



    Eine komplette API Dokumentation findet Ihr im doc Ordner in der CommonAPI.

Share

Comments 1

  • 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