Skip to content

Implement "HUD-Hooking"

NerduMiner requested to merge nerdyminer18/srb2p-public:mod-disable-hud-rendering into next

A lot of mods nowadays love to edit parts of the base game to add features or expand on portions of the game, but huds are prohibitively inaccessible and mods have to cope by just drawing parts of or the entirety of the same hud again.

This can be mitigated by allowing mods to "hook" into the original hud functions and tell them to not run, thereby increasing the performance of the game and allowing for more extensive hud edits. The table as of now only consists of groups of huds where all elements are local and inaccessible normally. More could be added in the future if needed.

It's also important to note that this merge request does not change the structure of any of the supported huds. This was done for simplicity and also so that only mods are liable for whatever instabilities or jank they come up while making hud edits.

Supported HUDS

  • NET (Team select, Character Select, etc. in Render_NET.LUA)
  • Battle (Command Wheel, etc. in Render_Battle.LUA)
  • Dungeon (Dungeon stuff in Render_Dungeon.LUA)
  • Scoreboard (Scoreboard stuff in Render_Scoreboard.LUA)
  • Title Screen (Just in case, allows for editing the hook in Title_Main.LUA)

Usage

*Inside a mod that wants to edit NET huds
EnabledHuds["NET"] = false
*Net hud redefining*

Merge request reports