CommonAPI2 Entwicklungsdiskussion, Fragen & Antworten

N0neGiv3N · Jul 23rd 2025

Thanks Eis_os. ~~I can't wait to use this!~~

I was able to keep the native.dll file from getting auto-deleted by Windows 11 , however even with using the Build OverWrite ability, I can't get the latest version of Common API to work with TpF2 Build Version 35732.

I get several errors before the game even starts:

Is this build of the Game not supported in the newest version of the Mod? Should I download an older version of Common API 2?

**eis_os** · Jul 23rd 2025

No, 35732 isn't supported. Only the last version 35924. Your version is more then a year old, there is no download version fot this game build.

That is exactly the reason why CommonAPI2 has a build version check in it. The build overwrite is not something to magical fix things... The whole structure of the game is different...

N0neGiv3N · Jul 23rd 2025

Quote from eis_os

No, 35732 isn't supported. Only the last version 35924. Your version is more then a year old, there is no download version fot this game build.
That is exactly the reason why CommonAPI2 has a build version check in it. The build overwrite is not something to magical fix things... The whole structure of the game is different...

Damn, If I knew that the old versions would be even gone from the internet archives, I would have downloaded and backed it up so I could have eventually used it. I stick to TpF2 Build 35732 because it's way easier for me to build stuff underground (last version without the build lines for tracks and streets, and don't have to hold shift the entire time to make the stupid tunnel selection menu not appear).

Looks like I'll either need to hunt down Version "1.8 20231215" somehow or just give up the idea of using this.

Thanks Anyway

**eis_os** · Jul 23rd 2025

What do you mean exact with holding shift?

N0neGiv3N · Jul 23rd 2025

Quote from eis_os

What do you mean exact with holding shift?

To clarify context of what I'm referring to:

After September 2024, if you decorate Train tunnels with assets, you will not be able to select them again without holding down shift. This is because the new Tunnel Entrance selector menu gets in the way the moment you try to (even if the Track segment is fully underground without a tunnel entrance portal anywhere in sight).

^This will appear instead of the "configure menu" box that allows me to rename a Sign.

If you hold down shift, it prevents this menu from popping up, allowing you to rename the Sign appropriately (This was mentioned by UG as a method needed to select double slip switches in tunnels post December 2024 Update.)

Since I work primarily underground, holding down shift the entire time while I work would give me carpal tunnel.

Therefore, I simply chose to downgrade to the previous version as it doesn't have that problem. UG has no intentions on fixing it since most people don't decorate underground to begin with.

**eis_os** · Jul 25th 2025

I am quite confident that the next CommonAPI2 will help with that

Like the no snap option with improveui, there will be a new icon

This will virtually change the game behavior, so technical it will only open tunnel type and bridge type when pressing shift.

This way I can modify double slip switches and signals in tunnels, so the chance is quite high this will work for constructions too.

For changing tunnel and or bridge types, you will need to press shift while this option is active.

N0neGiv3N · Jul 25th 2025

Now we are cooking with Gas! I'm so happy that this was already on your to-do list. I'm looking forward to it's release. With it, I can finally update to the latest version of the game if it works as intended (I'm sure it will if you are able to select the switches again).

oberhausener68 · Aug 11th 2025

Ich habe mal ne Frage zum Node-Editor.

Innerhalb des Kreisverkehrs kann ich einen BasisNode auswählen, habe aber keinen Zugang zu anderen Nodes innerhalb des Kreisverkehrs.

Den Weg/die Gleise von rechts kommend nach unten möchte ich gerne abstellen.

**eis_os** · Aug 11th 2025

Wenn du die (Tram)Einmündung weiter in die Mitte legst, sollte es klappen.

Ggf muss du die Nodedaten entfernen, die bei dem Tramgleisen liegen, das sieht komisch aus...

Wenn nicht, bräuchte ich das Savegame...

oberhausener68 · Aug 11th 2025

Oh, das ging schnell

Naja, ist zu überlegen, ob ich den unerwünschten Weg irgendwie akzeptiere oder eine enge Kurve für den Weg von oben nach rechts in kauf nehme...

Was heißt Nodedaten entfernen, die bei den Tramgleisen liegen?

**eis_os** · Aug 11th 2025

Die NodeDaten an der Position des roten Pfeils sehen komisch aus. Ggf. darauf klicken und Entfernen.

Normalerweise sollte die Position weiter unten sein.

Ggf. die Gleise mehr wie Gelb legen, damit die "Kreuzung/Einmündung etwas weiter nach unten wandert und die Position der Nodes eindeutiger werden...

(Du hast da an einem Punkt recht viele Nodes liegen)

Imsvale · Aug 14th 2025

Bug report:

CAPI2 seems to trigger redownloading of mods by the in-game mod handler, which propagates out to Steam after closing the game. This happens very frequently, and to a lot of mods.

I just went through a cycle of about 40 mods being downloaded. Closed the game. Steam finished downloading stuff. I open the game again, and after a little think, it wants to redownload another 28:

Excerpt from stdout.txt:

Code

commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Found 3463 mods
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Loaded 7 of 3464 mod descriptions from disk
Update of mod descriptions: 1490.58 ms
Found 3463 mods
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Loaded 7 of 3464 mod descriptions from disk
Update of mod descriptions: 1467.39 ms
Found 3452 mods
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Loaded 7 of 3453 mod descriptions from disk
Update of mod descriptions: 1494.36 ms
Found 3452 mods
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Loaded 7 of 3453 mod descriptions from disk
Update of mod descriptions: 1476.09 ms
Mods changed, recreating data...
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Found 3452 mods
commonapi2.init	20250726
commonapi2.ui:	Loading commonapi2.ui interface
Loaded 7 of 3453 mod descriptions from disk
Update of mod descriptions: 1511.22 ms

Display More

This does not happen without CAPI2. The behavior has been around pretty much since the in-game mod browser was released (and presumably CAPI2 was updated to interact with it).

Apologies if this has already been reported.

**eis_os** · Aug 14th 2025

CommonAPI2 can't trigger downloading mods, (The Steam API hasn't such a functionality, nor does CommonAPI2 tell TPF2/Steam to subscribe something without user interaction )

Code

Mods changed, recreating data...

Is created by TPF2, maybe some mod crashes with CommonAPI2 in mod.lua.

Code

Loaded 7 of 3453 mod descriptions from disk

Looks odd, technical you should have all mod descriptions in cache...

Do others here have this problem?

Haben andere dieses Problem?

Rover_Schnitzel · Aug 14th 2025

Offensichtlich nicht!

melectro · Aug 15th 2025

Quote from eis_os

Do others here have this problem?

No

esp.wittmann · Aug 15th 2025

I have approximately 2000 mods activated and I have no problem with the CommonAPI2.

Imsvale · Aug 16th 2025

Quote from eis_os

CommonAPI2 can't trigger downloading mods

Interesting. Yet this doesn't happen when I remove CommonAPI2.

Wonder what's causing it then...

**eis_os** · Aug 16th 2025

TPF2 and CommonAPI2 can only subscribe to steam mods. Downloading is handled by Steam.

CommonAPI2 reads the mod list via commonapi._native.dampf.getMods()

That's the only interaction with Steam.

Code: res\scripts\commonapi2\mods.lua

function mods._prepareSteamCache()
    mods._steamCache = nil
    if (commonapi._native and commonapi._native.dampf) then
        local steammods =  commonapi._native.dampf.getMods()
        if (steammods == nil) then
            return
        end
        mods._steamCache = {}
        for idx, steammod in ipairs(steammods) do
            steammod.idx = idx
            mods._steamCache[steammod.handle] = steammod
        end
    end

end

Display More

if in doubt, you can replace local steammods = commonapi._native.dampf.getMods() with local steammods = {}

And here is the c++ code:

The steam api documentation is public https://partner.steamgames.com/doc/api/ISteamUGC

Code

int Dampf_LUA_GetMods(lua_State *L) {
    DampfUGCObj* DampfUGC;
    
    DampfUGC = GetDampfUGC();
    if (DampfUGC == nullptr) {
        std::cout << "CommonAPI2 Workshop connection not possible\n" << std::flush;
        lua_pushnil(L);
        return 1;
    }

    std::vector<PublishedFileIdHandle> items;

    bool ret = DampfUGC_SubscribedItems(DampfUGC, &items);

    lua_newtable(L);

    int tableidx = 0;
    auto it = items.begin();
    for (int i = 0; it != items.end(); ++it, ++i) {
        PublishedFileIdHandle handle = *it;

        if ( DampfUGC->vtable->GetItemState(DampfUGC, handle) & 4 ) {
            char folder[2048] = { 0 };
            uint64_t sizeOnDisk;
            uint32_t timestamp;
            if (DampfUGC->vtable->GetItemInstallInfo(DampfUGC, handle, &sizeOnDisk, folder, 2000, &timestamp)) {
                lua_pushinteger(L, tableidx+1);
                lua_newtable(L);

                lua_pushinteger(L, handle );
                lua_setfield(L, -2, "handle");

                lua_pushstring(L, folder );
                lua_setfield(L, -2, "folder");

                lua_pushinteger(L, timestamp );
                lua_setfield(L, -2, "timestamp");
            
                lua_pushinteger(L, sizeOnDisk );
                lua_setfield(L, -2, "sizeOnDisk");

                lua_settable(L, -3);
                tableidx++;
            };
        }
    };

    return 1;
};

Display More

The WorkshopBackupFolder system doesn't touch steam, but works one layer above. (works even with the gog version)

But to be sure, you don't have a backup folder set?

Imsvale · Aug 18th 2025

Quote from eis_os

if in doubt, you can replace local steammods = commonapi._native.dampf.getMods() with local steammods = {}

Thanks, I'll give that a try just to confirm. But I believe you.

Quote from eis_os

The WorkshopBackupFolder system doesn't touch steam, but works one layer above. (works even with the gog version)
But to be sure, you don't have a backup folder set?

I do not have a workshop backup folder set:

Full stdout.txt if it is of any interest (from just starting the game, looking around the CommonAPI2 settings, and grabbing the above screenshot).

Edit: Just another stdout.txt with lots of the same spam, but this time during re-downloading of mods.:

**eis_os** · Aug 18th 2025

If you disable CommonAPI2:

"Loaded 7 of 3459 mod descriptions from disk" does this line change?

CommonAPI2 Entwicklungsdiskussion, Fragen & Antworten

Willkommen in der Transport Fever Community

Share