Need of comments for example in WIKI construction_postRunFn.lua

melectro · 26. September 2020

I'm interested to understand the last part of the example in the WIKI https://transportfever2.com/wi…ction_postRunFn.lua.html#

Here is the part:

I have so far found that this is overwriting the first params created above this section. Why make an example so complicated for "newbies" and no comments in the code?

Anyway, I have in my tests run without this part and got it to start, but I get an error when trying to build the construction. "No mod"

in the construction directory there is only the .script file, but no con file (the name of the con is same as the script file) as it is built dynamically in the mod.lua:

The settings are updated and that can be seen when selecting the construction in the game. I get the feeling that the script file isn't started and I can't find my fault.

(The script file worked earlier before I rewrote the mod.lua to make the dynamic construction.)

transportfever.net/wsc/attachment/159633/

stdout.txt

Code

Exception type: Lua exception

This error is usually caused by modding. Some game resources contain incorrect data.

Details:

Error message: error: attempt to call a nil value
stack traceback:
    =[C](-1): ?


File name: res/construction/creek_bridge_street

Key: game/res/script/construction/creek_bridge_street/createTemplateFn

Minidump: I:/Steam/userdata/70790454/1066780/local/crash_dump/55a0df86-df6e-4163-b47f-593d45c7c3e3.dmp

Mod: no mod

In file: c:\build\tpf2_steam\src\lib\lua\state.cpp:586

In function: void __cdecl lua::State::Call(int,int)


Exception type: Lua exception

This error is usually caused by modding. Some game resources contain incorrect data.

Details:

Error message: error: attempt to call a nil value
stack traceback:
    =[C](-1): ?


File name: res/construction/creek_bridge_street

Key: game/res/script/construction/creek_bridge_street/createTemplateFn

Minidump: I:/Steam/userdata/70790454/1066780/local/crash_dump/c5a343eb-f341-46f9-a16a-dde4c23fac19.dmp

Mod: no mod

In file: c:\build\tpf2_steam\src\lib\lua\state.cpp:586

In function: void __cdecl lua::State::Call(int,int)

Alles anzeigen

snippet from the mod.lua

Code

            local con = api.type.ConstructionDesc.new()
                con.fileName = "creek_bridge_street.con"
                con.type = api.type.enum.ConstructionType.STREET_STATION
                con.description.name = _("Small street bridge")
                con.description.description = _("small bridge").
.
.
.
            local myCon = string.gsub(con.fileName, '.con', '')
            con.updateScript.fileName = "construction/"..myCon..".updateFn"
            con.updateScript.params = {
--                param1 = "param1",
                autobahn_mod = hasAutobahnMod,
            }
            con.preProcessScript.fileName = "construction/"..myCon..".preProcessFn"
            con.preProcessScript.params = {
--                param1 = "param1",
                autobahn_mod = hasAutobahnMod,
            }
            con.upgradeScript.fileName = "construction/"..myCon..".upgradeFn"
            con.upgradeScript.params = {
--                param1 = "param1",
                autobahn_mod = hasAutobahnMod,
            }
            con.createTemplateScript.fileName = "construction/"..myCon..".createTemplateFn"
            con.createTemplateScript.params = {
    --            param1 = "param1",
                autobahn_mod = hasAutobahnMod,
            }

            api.res.constructionRep.add(myCon, con, true)

Alles anzeigen

VacuumTube · 27. September 2020

Are you using createTemplateFn and is it defined in creek_bridge_street.script ?

melectro · 27. September 2020

Actually I'm not in the need of createTemplateFn in the script file for my mod to work, but if the game needs it, I don't know. I have tested to remove the lines including the functions in the mod.lua, and then I get following error.

Code

            con.updateScript.fileName = "construction/"..myCon_file..".updateFn"
            con.updateScript.params = {
                paramPath = par1Path,
                param1 = par1Icons,
                streetwidth = par1streetwidth,
                Abn_Path = AbnPath,
--                autobahn_mod = hasAutobahnMod,
            }
--            con.preProcessScript.fileName = "construction/"..myCon_file..".preProcessFn"
--            con.preProcessScript.params = {
--                paramPath = par1Path,
--                param1 = par1Icons,
--                streetwidth = par1streetwidth,
--                Abn_Path = AbnPath,
--                autobahn_mod = hasAutobahnMod,
--            }
--            con.upgradeScript.fileName = "construction/"..myCon_file..".upgradeFn"
--            con.upgradeScript.params = {
--                paramPath = par1Path,
--                param1 = par1Icons,
--                streetwidth = par1streetwidth,
--                Abn_Path = AbnPath,
--                autobahn_mod = hasAutobahnMod,
--            }
--            con.createTemplateScript.fileName = "construction/"..myCon_file..".createTemplateFn"
--            con.createTemplateScript.params = {
--                paramPath = par1Path,
--                param1 = par1Icons,
--                streetwidth = par1streetwidth,
--                Abn_Path = AbnPath,
--                autobahn_mod = hasAutobahnMod,
--            }

            api.res.constructionRep.add(myCon_file..".con", con, true)
        local hasCbridge = api.res.constructionRep.find(myCon_file..".con") >= 0
        print ("hasBridge =",hasCbridge,myCon_file)

Alles anzeigen

At the end of mod.lua I have placed a debugprint "hasBridge...." and this line isn't executed as the error above happens at the missing format.

Letting the comments away and activate the functions in the scriptfile doesn't help. A new error, very informative...:

here is what I have written in the script file:

Code

 function data()
    return {
--    preProcessFn = function(params, paramsFromModLua)
--    end
--    upgradeFn = function(params, paramsFromModLua)
--    end
--    createTemplateFn = function(params, paramsFromModLua)
--    end
    updateFn = function(params, paramsFromModLua)
  
--  My construction code is here....

    end

Alles anzeigen

stdout.txt

Code

adding archive res/models/models.zip
ModelRep: 6387.35 ms
hasBridge =    true    creek_bridge_street
No resources are missing!
texture load error: file not found: res/textures/.tga
MinidumpCallback: dumpPath "I:/Steam/userdata/70790454/1066780/local/crash_dump/", minidumpId "4c92bced-9c21-422a-9f9f-c74c92b464c2", succeeded 1
local time is Sun Sep 27 17:32:03 2020

An error just occurred.

VacuumTube · 27. September 2020

You should be able to remove to script filename functions, that are not needed.

What kind of lua error are you getting?

melectro · 27. September 2020

I'm getting the error mentioned above.

Zitat

An error just occurred.

When removing the script functions, I get the first mentioned error above.

VacuumTube · 27. September 2020

Zitat von melectro

I have tested to remove the lines including the functions in the mod.lua, and then I get following error.

There has to be more info in the stdout

EISFEUER · 27. September 2020

melectro You found a good part for the dynamic param puzzle. I don't have recongnized this script. Thanks for it
I've testet the marked lines of code. They are working fine in my context.

The problem is, that the whole code snipped doesn't make sence for me and will not help in your context.
Here are the comments you requested:

```

Code: construction_postRunFn.lua from UG Api example

-- get own construction from the repository
local con = api.res.constructionRep.get(api.res.constructionRep.find("myCon"))
-- create param object with all typical properties (same as the difinition in the con)
local par1 = api.type.ScriptParam.new()
par1.key = "key_2"
par1.name = "Key 2"
par1.tooltip = "Key 2 (tooltip)"
par1.values = {"1", "2", "3"}

-- Creates general construction template
local templ = api.type.ConstructionTemplate.new()
-- Creates content for a dynamic template
local dyn = api.type.DynamicConstructionTemplate.new()
-- Assign param to template
dyn.params[1] = par1

-- Name of the template
templ.desc.name = _("My Construction")

-- Assign dynamic template data to the template itself
templ.data = dyn

-- add template with one param to the construction
con.constructionTemplates[1] = templ

Alles anzeigen

```

So far so good.

What not makes sence to me is. In the lines above they create an asset object. The construction templates are good for modular construction, but does not help in case of asset (except they are modular, but in this snippet there are no modules created for it). This param will appear in the createTemplateFn() where you define where all the module should be placed. If you have no module you will have `return {}` and the parameter have no impact. You will need this parameter in the updateFn().

I have tried to add a parameter to my existing params of my constructionTemplate. This does't change anytihing. Same with manipulating one of my params . No changes. When I clone my construction template, add a new parameter and override my old constructionTemplate it works.

EDIT: only for my own interest. What does a `preProcessFn`? (Was assigned to the asset in this code snipped) I never heard of it before.

EDIT: I've got the sulution.
Adding params are have no effects on the constructionTemplate only does have no effect. When I add params to the normal construction param list it works fine.

Code

-- get bench asset from repository
local bench = api.res.constructionRep.get(api.res.constructionRep.find('asset/default_multi_bench_new.con'))

-- create a new param object
local colorParam = api.type.ScriptParam.new()
colorParam.key = "bench_color"
colorParam.name = "Bench Color"
colorParam.tooltip = "Choose you bench color"
colorParam.values = {"red", "green", "blue"}

-- add new param to the bottom of the param list
bench.params[bench.params + 1] = colorParam

Alles anzeigen

Here is the evidence

melectro · 28. September 2020

Zitat von VacuumTube

There has to be more info in the stdout

No there is no more information than the normal lines at loading the game. Here is the full stdout.txt if you don't believe me.

EISFEUER

Thanks' for enlighten me.

Zitat von EISFEUER

What not makes sence to me is. In the lines above they create an asset object.

in my case it was the opposite, the second part didn't make any sense to me as I changed the definition in the first part to STREET_STATION and deleted my "mod".con in the construction folder.

The first part is creating a complete con file in the repository. What I'm guessing is, if you want to omit the first part and instead have your own .con file in the construction folder, you could use the second paragraph. Unfortunately, it is not clear in the example and that is the comment I was looking for. I have tested to use only the second part (by reintroducing my .con file in the construction folder), but it also creates errors.

I like to use the first part where the con is dynamically created, but I'm trying to find how to interpret following two lines:

Code

con.fileName = "myCon"

Should the file name "myCon" include ".con" or not?

Code

        con.updateScript.fileName = "construction/cons.updateFn"

I have seen in other examples that "cons" is normally the name of myCon without ".con". Here it is only confusing me in following points.

the "s" in "cons.updateFn". For me the s means plural of con (=constructions)
Why not use the same name as the construction in the example?
It would have been nice if the example pointed to the use of a script file. Even better if the script file is also presented.

VacuumTube · 28. September 2020

I would exclude the .con in the name, as they do in the example.

In my case I have a .con file defining the info and in mod.lua I am assigning the external script file.

This is working and I would prefer this method.

Code

con.updateScript.fileName = "construction/cons.updateFn"

I have no idea why they use cons. The filename refers to .script file. In this case this would be "res/construction/cons.script". Behind the . is the function name (updateFn) that is defined in the .script file.

Also described here: https://www.transportfever2.co…ons#construction_updatefn

melectro · 29. September 2020

I have read the description three times and still I don't understand or get it working.

Zitat von EISFEUER

If you have no module you will have `return {}` and the parameter have no impact.

from the .script file

Code

 function data()
    return {
    preProcessFn = function(params, paramsFromModLua)
        return { }
    end
    upgradeFn = function(params, paramsFromModLua)
        return { }
    end
    createTemplateFn = function(params, paramsFromModLua)
        return { }
    end
    updateFn = function(params, paramsFromModLua)
 -- get Params from mod.lua

        local result         = { }
        result.groundFaces   = { }
        result.models        = { }
        local terrainFaces   = { }
        local groundFace     = { }
        .
        . My construction code is here
        .
        return result
    end
        
    }
end

Alles anzeigen

I have placed the return {} in the xxxFn functions in the .script file, but still I get the message "An error just occured"

here are the lines after the normal startup info in stdout.txt

Code

adding archive res/models/models.zip
ModelRep: 6316.05 ms
No resources are missing!
texture load error: file not found: res/textures/.tga
MinidumpCallback: dumpPath "I:/Steam/userdata/70790454/1066780/local/crash_dump/", minidumpId "ab5993b4-e9b5-477d-a110-9da05005243f", succeeded 1
local time is Tue Sep 29 17:31:13 2020

An error just occurred.

EISFEUER · 29. September 2020

There are missing a lot of commas.

Code

 preProcessFn = function(params, paramsFromModLua)
 return { }
 end,
 upgradeFn = function(params, paramsFromModLua)
 return { }
 end,
 createTemplateFn = function(params, paramsFromModLua)
 return { }
 end,

I don't know what the preProcessFn() returns

melectro · 30. September 2020

Thank you!

Zitat von EISFEUER

missing a lot of commas

Interesting and UG may have forgotten to make this error information more informative. Other errors are very good they point on the row where to look, but here.... nothing.

Placing the commas after the end and this error is gone.

VacuumTube · 30. September 2020

If you're not using them, why do you include them anyway? I don't know if it will cause problems, when you return { }

melectro · 30. September 2020

Zitat von VacuumTube

why do you include them anyway?

I would be glad to ignore them, but I can't. if I remove them from the mod.lua I get this error

VacuumTube · 30. September 2020

And is there more in stdout for this error? Usally Lua errors have a detailed error message

melectro · 1. Oktober 2020

I have already deleted all files permanently in the crash dump folder and restored the mod lua and script file to the version that is working. I'm following the example in the WIKI and there the lines are written. I guess that they have to be there. https://transportfever2.com/wi…ction_postRunFn.lua.html#

melectro · 2. November 2020

After i have studied the example in WIKI https://transportfever2.com/wi…uction_postRunFn.lua.html, I found that there is probably an undocumented function called api.type.StaticConstructionTemplate. The example uses Dynamic, but how to configure it as Static? Is there anyone of you that know something to explain how to set it up for Static?

I can tell that when I only change the name into Static I get an error as the api.type.StaticConstructionTemplate.new() returns a NIL value

melectro · 7. November 2020

I have for the moment created two mods with DynamicConstruction and when enabling both, one of them doesn't work as the ParamsfromLua will only be read from the last activated mod. Though it works fine if I just enable it as stand alone.

1)

Is there a limit that the game can only handle one mod with dynamicConstruction?

2)

Regarding my question above. I have found inside the TpF2.exe file these modules, but I cant find any documentation about StaticConstruction. Experimenting isn't making any progress.

VacuumTube · 7. November 2020

Zitat von melectro

and when enabling both, one of them doesn't work as the ParamsfromLua will only be read from the last activated mod

don't know what you are doing with params, but you should maybe know, there is a bug regarding modparams where keys from one mod might override other mods. So make sure, you are using unique keys.

Isn't a static construction similar to a dynamic and differs only in the template modules? Maybe you don't need static?

melectro · 8. November 2020

Zitat von VacuumTube

there is a bug regarding modparams

That I didn't know, Thank you it makes sense to what I have seen.

About Static/Dynamic, actually I'm trying to find why the setting menu isn't showing up on the right side when I select "configure" on the dynamic construction after it has been built. I wish to make a change, but the menu does not appear as it is doing for a standard mod like my Autobahnkreuz.

Need of comments for example in WIKI construction_postRunFn.lua

Willkommen in der Transport Fever Community

Teilen