(Possible) Breaking change: local variables references inside nested function definitions
-
@fortune said in (Possible) Breaking change: local variables references inside nested function definitions:
Sorry but the above suggestion is not a "fix", it is a prevention workaround
Of course it is a fix. There was a problem in the language that lead to unintentional behaviour so now it throws a proper error and prevents users from facing this issue.
And if your finished project doesn't have any issues that come from this problem, you don't need to do anything, but the next time you'll update it and it start throwing these errors, you can fix them and sleep better.
-
@christoph-hart I'm getting an error in my expansion installer callback on the line "local origin = hr;". I think this was largely copied from one of the example projects provided by @Christoph-Hart.
Just so I'm crystal clear, do I want to be using something other than 'local'?
I've had some users reporting that the expansion installer gets stuck trying to install the samples - I wonder if this is related...
inline function onINSTALLEXPControl(component, value) { if (value == 1) { local msg = "SELECT EXPANSION .hr1 FILE"; Engine.showYesNoWindow("SELECT .HR1 FILE", msg, function(response) { if (response) { FileSystem.browse(FileSystem.Downloads, false, "*.hr1", function(hr) { if (hr.toString(2) == ".hr1") { local origin = hr; // Scoped copy msg = "SELECT A LOCATION FOR THE SAMPLE FILES"; Engine.showYesNoWindow("SAMPLE LOCATION", msg, function(response) { if (response) { FileSystem.browseForDirectory(FileSystem.Samples, function(dir) { expHandler.installExpansionFromPackage(origin, dir); }); } }); } }); } }); } } Content.getComponent("INSTALLEXP").setControlCallback(onINSTALLEXPControl);
-
@danh You need to declare that variable as a reg outside of the function, put it at the top of your script/namespace
-
@d-healey ok so just:
reg origin = hr; // Scoped copy inline function onINSTALLEXPControl(component, value) { if (value == 1) { local msg = "SELECT EXPANSION .hr1 FILE"; Engine.showYesNoWindow("SELECT .HR1 FILE", msg, function(response) { if (response) { FileSystem.browse(FileSystem.Downloads, false, "*.hr1", function(hr) { if (hr.toString(2) == ".hr1") { msg = "SELECT A LOCATION FOR THE SAMPLE FILES"; Engine.showYesNoWindow("SAMPLE LOCATION", msg, function(response) { if (response) { FileSystem.browseForDirectory(FileSystem.Samples, function(dir) { expHandler.installExpansionFromPackage(origin, dir); }); } }); } }); } }); } } Content.getComponent("INSTALLEXP").setControlCallback(onINSTALLEXPControl);
-
@DanH yes this is example ticks all boxes for that issue, but I can't guarantee that there is nothing else wrong :)
But there is another code smell - you're declaring the local variable inside the nested function definition, which should not be possible (and I think the recent change will also prevent that, but I'll have to check).
In your case you might get away with just changing
local
tovar
for the origin definition. -
@christoph-hart yes I changed 'local origin = hr;' to 'var origin = hr;' and the errors were gone.
EDIT: It's all going wrong when trying to install an expansion now though :face_with_tears_of_joy:
-
@danh said in (Possible) Breaking change: local variables references inside nested function definitions:
if (hr.toString(2) == ".hr1")
Magic number alert!!! You should use
hr.toString(hr.OnlyExtension)
-
@danh said in (Possible) Breaking change: local variables references inside nested function definitions:
ok so just:
Yes, but it's no longer scoped now so you can change that comment ;)
Also
hr
does exist at init so you can't assign the value there, you have to do that within your function like you were before. -
@d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:
Also hr does exist at init so you can't assign the value there, you have to do that within your function like you were before.
with 'var'?
-
@danh I'd say use a reg but if Christoph says a var is okay then var is ok. My point was you have
reg origin = hr
at the top of your script now, buthr
doesn't exist until yourFileSystem.browse
call, so you can't assign it when you declare theorigin
variable at the top of your script you have to assign it after the call tobrowse
just like you were withlocal origin = hr
now you just putorigin = hr
. Or do what Christoph said. -
This post is deleted! -
@d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:
Magic number alert!!! You should use hr.toString(hr.OnlyExtension)
Right, changing to the above makes the install process stop before the window appears allowing me to select the destination for the samples. So... select the .hr1 file and then nothing more...
-
@danh Oo could be that the constant is bugged. I'm away from the computer for the next day so can't test, stick to your magic number for now :)
-
hr
was already external, right? so why bother using another variableorigin
for the same thing in the first place?
It might be me, everyone around is telling me I need glasses... Arfff... 44... might be the time anyway... -
@ustk hr comes from the file browse call but the scope doesn't extend to the second browse call so it needs to be stored in a temporary variable
-
Just to say that I updated my custom branch, and all my
var
changed tolocal
in the current project that is dependent on this very custom branch.
It's not a big deal to change back everything though as I remember this fix. But in the case it can be fixed it could help other people not to have this surprise, without knowing where it comes from :) -
This post is deleted! -
@ustk Same here. I've used tons of local variables in all of my projects. Now this shit comes...
-
@orange This problem was always there, it's just now you get a warning. It only applies to local variables in certain circumstances.
-
@d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:
@orange This problem was always there
My previous projects can't be opened with the latest develop branch.
But if I modify thelocal
variables asvar
it works. So this issue is a new one.