Gameplay State (CET utility for modders)

During mod research I realized that detecting if the player is in active gameplay or not is harder then it should on this game, so I decided to build this utility to provide a way to provide real-time active gameplay state detection, so you don't have to write heavy frame loops or observers.

It handles state tracking gracefully and updates dependent mods using an event listener system, so you don't need to call it more than once and it's extremely performant as it doesn't rely on onDraw calls.

Usages examples

• []If your mod has an UI element that you want to hide on specific cases / when the player is not in active gameplay[/]

  []Actions you want to trigger on specific states covered by the utility.[/]

  Credits / Thanks

  • []Special thanks to psiberx for the open-source CET KIT. This utility relies specially on the included GameSession from him, to handle most of the raw detections.[/]

  ---

  Multi-Return State System

  The utility returns two values simultaneously: a boolean (isPlayerInControl) and a string (currentControlState).

  Disclaimer: This utility provides high-level macro state detection. It is designed to tell you if gameplay is suspended, not to provide super granular UI tracking. For example, it will not tell you which specific menu or inventory tab is open, that's out of scope.

  Tracked States & Coverage

  []In Gameplay (Control: true) - Player has full control of V, normal gameplay (default after game session loaded)[/]

  []Paused (Control: false) - Covers in-game full screen menus (inventory, map, quests, etc); Pause/Esc Menu; Photo Mode; in-game travelling / loading screens; Breach Protocol hacking minigame.[/]

  []Blur Menus (Control: false) - Covers overlay menus such as Weapon / Quick-Slots wheel, Vehicle call, Radio overlay.[/]

  []Phone Menu (Control: false) - Covers the mobile phone / contact call list. This is unique because I had to build the detector for it as GameSession is not detecting it properly.[/]

  [*]In Cutscene (Control: false) - Covers an