{"id":124,"date":"2025-08-26T14:05:51","date_gmt":"2025-08-26T14:05:51","guid":{"rendered":"https:\/\/blogs.scummvm.org\/superlemon\/?p=124"},"modified":"2025-08-26T14:06:54","modified_gmt":"2025-08-26T14:06:54","slug":"another-upgrade-to-the-imgui-debugger","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/superlemon\/2025\/08\/26\/another-upgrade-to-the-imgui-debugger\/","title":{"rendered":"Another upgrade to the ImGui Debugger"},"content":{"rendered":"

For the last week of GSoC, I was working on some more improvements to the ImGui Debugger in the Director engine. Making the ImGui debugger as close to the original Director engine as possible will be very helpful in adding support for games in the future.<\/p>\n

The first thing to do was to revamp the Functions window. It used to show all the handlers from all the scripts in the window in a single table. Since, that was not only messy and not properly navigable, @sev asked me to revamp it so that there are two views:<\/p>\n

\"\"\"\"<\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

One: that shows all the handlers just like how it was shown previously and two: one that shows each script, and each script (‘Lscr’ context) and under each script we have all the handlers in that script. This allows us to navigate between scripts very easily. This also means, in the second view, the filtering works better, i.e. we can filter out all the handlers with a certain name (e.g. mouseUp<\/code>) or those associated with a particular cast member (say no. 123) easily.<\/p>\n

After that, we noticed that some of the scripts didn’t show the cast member number in the Execution Context window properly (e.g. -1 for the topicmaker:mnew in the screenshot):<\/p>\n

\"\"<\/p>\n

Now, the cast id (even though present in the ‘Lscr’ data stream, is not reliable) is fetched from the associated cast member. Since cast IDs and script IDs are linked together, we can map the script ID to its corresponding cast ID. But, it was possible that some of the cast members are not loaded, because of lack of support or some error (e.g. Picture cast member). Hence, at first I thought, forcing the loading of their cast member info might solve this problem. However, I was wrong. But I thought it might still be a good and harmless addition, hence I made a PR<\/a>.<\/p>\n

It turns out that some of the ‘Lscr’ contexts are factory scripts, i.e. they have a parent script (which is associated with a cast member) and the handlers in the current script context are called in reference to the parent’s cast member. As you can see from the following screenshot of LCARS___.dir loaded into the origin Director engine, the handler `topicmaker:mnew` is part of a movie script (cast ID: 1285):<\/p>\n

\"\"<\/p>\n

Even while dumping the scripts, ProjectorRays\/ScummVM dumps the handlers in the current script as part of the parent script and completely ignores the current script (the one without a cast member associated):<\/p>\n

\"\"<\/p>\n

This is the list of all the parent scripts and their child script:<\/p>\n

“`
\nWho is: 236, whose parent: 89
\nWho is: 239, whose parent: 93
\nWho is: 232, whose parent: 234
\nWho is: 188, whose parent: 599
\nWho is: 597, whose parent: 623
\nWho is: 216, whose parent: 624
\nWho is: 21, whose parent: 646
\nWho is: 230, whose parent: 657
\nWho is: 26, whose parent: 721
\nWho is: 131, whose parent: 722
\nWho is: 24, whose parent: 723
\nWho is: 179, whose parent: 725
\nWho is: 131, whose parent: 727
\nWho is: 163, whose parent: 728
\nWho is: 199, whose parent: 729
\nWho is: 131, whose parent: 730
\n“`
\nHence, the solution was to not show the associated castID but rather the script ID, which is unique to each script. Hence, it required storing the parent number and the script number in the ScriptContext<\/code> class, and show that in the Execution Context window. This solved the problem. @sev then asked me to change all the references to a handler in a similar way, including the way we name the dumped scripts. This honestly took way too much time to figure out.<\/p>\n

Also, the scripts are now shown in a separate window when we click on a handler in the Functions window rather than showing them in the Execution Context window. Hence, we can see as many scripts as we want at the same time.<\/p>\n

Also, the handlers in the call stack are now selectable. You can click on them to jump to the exact byte code in the script shown below in the Execution Context window. To make the scrolling work, I had to include a separate boolean in the ImGuiState<\/code> struct.<\/p>\n

After that, there were a bunch of minor issues, like the scrolling in the Execution Context window when we jump to the definition, sanity checks for fetching `ScriptContext` through the handler Director::DT::getScriptContext<\/code>, marking the script dirty when a button in the control panel is placed, and some other stuff too minor to notice here.<\/p>\n

Also, in the Score, the original director shows whether or not a sprite changes in subsequent frames. Like follows:<\/p>\n

\"\" \"\"<\/p>\n

I was working on adding a similar functionality in the Score window, but I’m only halfway there.<\/p>\n

\"\"<\/p>\n

I’ll be adding the rest of the functionality in the next two days.<\/p>\n

Hence, overall a slightly less than average week. I was busy over the weekend for the academic project for final year (my faculty advisor is not happy with our progress). Initially I planned on making this post my final submission, but later decided against it. I’ll be making a separate post underlining all the progress that I made over the last\u00a0 12 weeks as my final submission.<\/p>\n","protected":false},"excerpt":{"rendered":"

For the last week of GSoC, I was working on some more improvements to the ImGui Debugger in the Director engine. Making the ImGui debugger as close to the original Director engine as possible will be very helpful in adding support for games in the future. The first thing to do was to revamp the […]<\/p>\n","protected":false},"author":27,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[14],"tags":[],"class_list":["post-124","post","type-post","status-publish","format-standard","hentry","category-week-12"],"_links":{"self":[{"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/posts\/124","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/users\/27"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/comments?post=124"}],"version-history":[{"count":3,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/posts\/124\/revisions"}],"predecessor-version":[{"id":139,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/posts\/124\/revisions\/139"}],"wp:attachment":[{"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/media?parent=124"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/categories?post=124"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/superlemon\/wp-json\/wp\/v2\/tags?post=124"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}