Introduce the RmlUI debugger #1845
Conversation
Somehow it doesn't work
| @@ -432,6 +432,7 @@ static void CG_BeaconMenu_f() | |||
| Rocket_DocumentAction( rocketInfo.menu[ ROCKETMENU_BEACONS ].id, "show" ); | |||
| } | |||
|
|
|||
| void CG_RmlUIDebuggerToogle(); | |||
| @@ -1184,6 +1185,8 @@ void CG_Init( int serverMessageNum, int clientNum, const glconfig_t& gl, const G | |||
| new(&cg) cg_t{}; | |||
| for ( centity_t& ent : cg_entities) { ent = {}; } | |||
|
|
|||
| CG_RmlUIDebuggerDisable(); // CHECKME | |||
There was a problem hiding this comment.
CG_Init is only called after a VM is freshly loaded so this is not needed here. Maybe you meant to put it in a shutdown function?
There was a problem hiding this comment.
Further, I think rmlui will clean up the debugger by itself in the shutdown function. Thus, I think we can probably remove the function all together.
| { | ||
| if (!debugger_initialised) | ||
| { | ||
| Rml::Debugger::Initialise(*cgs.mapname // CHECKME |
There was a problem hiding this comment.
You probably want an argument for hud/menu or at least allow for an override because people may want to debug ingame menus and such when a map is loaded. Furthermore, iirc, we never inject mouse/input events into the HUD context, so you can't actually use the debugger in that context (I think...)
There was a problem hiding this comment.
Ah, wait, are the in-game menu part of the menu or HUD context?
There was a problem hiding this comment.
Anything clickable is always the menuContext (ie, if you're in game and press ESC, you are in the menuContext). The hudContext is exclusively the the HUD (ie, things you can't click on because your mouse/keyboard are captured by the game. The only thing you you might actually want to click on is the tab scoreboard, which is part of the hud context.
There was a problem hiding this comment.
Then it makes things more complicated for the keybindings in particular. I'm not sure what would be the correct, non-surprising behavior. Use two keys? Press the same key several times (none->menu->hud->none)?
There was a problem hiding this comment.
In games like CSGO, which have a similar scoreboard, if you open a clickable HUD element, you right click to bring up a mouse.
Clickable HUD elements might be interesting if we ever want to be cool like Doom3 and have clickable menus in the map.
| { | ||
| if (!debugger_initialised) | ||
| { | ||
| Rml::Debugger::Initialise(*cgs.mapname // CHECKME |
There was a problem hiding this comment.
Also, once you pick a context, are you locked into that context forever?
There was a problem hiding this comment.
That's the best I can do with current RmlUI, yes. More recent versions have introduced Rml::Debugger::Shutdown(); which would allow switching
There was a problem hiding this comment.
Rml::Debugger::SetContext still exists and probably works.
There was a problem hiding this comment.
Looking deeper, it seems we always want to initialize the debugger into the menuContext and then allow switching between the two via debuggerToggle menu or debuggerToggle hud. Still unsure if debuggerToggle will work with the hudContext though.
There was a problem hiding this comment.
Currently it didn't work with the HUD, which is why I didn't notice that there was two contexts (EDIT: two contexts active at the same time)
There was a problem hiding this comment.
For now, let's just enable the debugger for the menuContext and leave the hudContext as a TODO. This should make the code easier for now.
| if (debugger_initialised) | ||
| { | ||
| Rml::Debugger::SetVisible(false); | ||
| //Rml::Debugger::Shutdown(); // TODO(recent rmlui) |
There was a problem hiding this comment.
It's probably not terrible to leave the debugger loaded. After all, you only load it when you are debugging something and you'll probably want to debug something else.
| { | ||
| if (!debugger_initialised) | ||
| { | ||
| Rml::Debugger::Initialise(*cgs.mapname // CHECKME |
There was a problem hiding this comment.
For now, let's just enable the debugger for the menuContext and leave the hudContext as a TODO. This should make the code easier for now.
| @@ -1184,6 +1185,8 @@ void CG_Init( int serverMessageNum, int clientNum, const glconfig_t& gl, const G | |||
| new(&cg) cg_t{}; | |||
| for ( centity_t& ent : cg_entities) { ent = {}; } | |||
|
|
|||
| CG_RmlUIDebuggerDisable(); // CHECKME | |||
There was a problem hiding this comment.
Further, I think rmlui will clean up the debugger by itself in the shutdown function. Thus, I think we can probably remove the function all together.
It has a companion PR on unvanquished_src.dpkdir to add keybindings for it.