Lua's onconsoleclose is broken

[SuuperW]

The Lua event onconsoleclose does not work, and the only way to trigger it does not involve closing the emulator. The code calling it is in LuaLibraries.Close, but all scripts are stopped (and their callbacks cleared) before this method runs. Lua scripts will not be stopped if the core reboot is due to client.reboot_core, but then LuaLibraries.Close also is not called so the Lua event still is not triggered.

Repro

Run this script, and observe it does not print when rebooting the core or closing the ROM:

event.onconsoleclose(function()
	print("console closed")
end)

while true do emu.frameadvance() end

The only way to trigger it is to close the Lua Console tool, which is a situation where it should not trigger. If you replace the print with something like client.togglepause() you can observe the event being triggered when you close the tool. The name "on console close" actually makes some sense for something that runs when the Lua Console tool closes, since the tool has "console" in it's name; but the Lua function's description says "Fires when the emulator console closes" so it refers to the emulator core, not the Lua Console.

I discovered this issue while looking for a workaround for #4629, trying to find a way to detect core reboots in a Lua script exit handler. (I did not find one.)

Output

No error message.

Host env.

Current master, 2.11, and 2.9.1 all have this issue and are the only versions I've tested.

[YoshiRulz]

The documentation is ambiguously-worded; the function is working as intended.

[SuuperW]

How did you decide from that link that the function is supposed to run when the tool is closed? The PR's OP and one of the commits say when the "emulator closes".

[YoshiRulz]

Because the trigger was placed in Win32LuaLibraries.Close with the other cleanup steps? Maybe OP's initial idea was to have a callback fire when EmuHawk is closed, but that would be less useful and harder to implement, hence I asked for the name to be changed to match the existing behaviour.

The name "on console close" actually makes some sense for something that runs when the Lua Console tool closes, since the tool has "console" in it's name; but the Lua function's description says "Fires when the emulator console closes" so it refers to the emulator core, not the Lua Console.

I think what's happened is that you've mentally corrected "emulator console closes" to "emulated system stops", but another possibility which makes more sense is "frontend terminal closes".

[RetroEdit]

If it's had this same behavior since... 2.6.3, it probably shouldn't change; the Lua API is intended to be (mostly) stable between versions.

It is unfortunate the "console" could be understood both in the sense of terminal and emulated system, but this seems like an easy fix by explicitly saying Fires when the emulator console closes -> Fires when the Lua Console closes.

[SuuperW]

OK, so it does look like the event has always worked this way. So it should just have its documentation updated.