fix(VR): fix exiting menu using controllers

[alandtse]

Summary by CodeRabbit

• Bug Fixes

  • More reliable detection of open/closed UI menus, reducing unintended actions.
  • Closing the Community Shaders menu now works even if UI menus appear closed.
  • Prevents mappings from triggering when menus are disabled, improving consistency.
  • Preserves one-action-per-frame behavior to avoid duplicate inputs.

• Refactor

  • Streamlined input mapping logic for clearer, more maintainable behavior without changing public functionality.

[coderabbitai]

Walkthrough

Refactors VR menu input handling in src/Features/VR.cpp by introducing a mapping framework with per-entry lambdas and state flags. Adds early UI state evaluation, a gating mechanism for closed-UI scenarios, and preserves single action per frame. Existing open/close Community Shaders mappings are migrated, with close allowed when UI menus are closed.

Changes

Cohort / File(s)	Summary
VR Input Mapping Refactor src/Features/VR.cpp	Added uiMenusOpen and inValidMenuState; introduced MenuStateMapping with allowWhenUIMenusClosed; replaced static mappings with lambda-based vector and CheckCombo; implemented onlyAllowClose gating to run only close-allowed mappings when UI menus are closed; maintained break-after-execute behavior; migrated open/close Community Shaders mappings.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant VR as VR Frame Loop
  participant UI as UI State
  participant Map as Mapping Engine

  Note over VR,Map: Frame start

  User->>VR: Input combos
  VR->>UI: Query MainMenu/TweenMenu state
  UI-->>VR: uiMenusOpen, menu enabled

  VR->>VR: Compute inValidMenuState
  alt Menus closed but menu enabled
    Note right of VR: onlyAllowClose = true
    VR->>Map: Iterate mappings (allowWhenUIMenusClosed only)
  else Normal state
    VR->>Map: Iterate all mappings
  end

  loop In order
    Map->>Map: CheckCombo()
    alt Combo matches and allowed
      Map-->>VR: Execute action
      Note over VR: Break (one action per frame)
    else No match
      Map-->>VR: Continue
    end
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I twitch my whiskers, flip a bit—how neat!
New maps now hop in tidy, ordered feet.
When menus snooze, the close can still proceed,
One hop per frame—just what bunnies need.
In VR fields I bound and preen,
Refactors crisp, the logic clean. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "fix(VR): fix exiting menu using controllers" accurately reflects the primary intent of the changes in src/Features/VR.cpp, which add uiMenusOpen, MenuStateMapping with allowWhenUIMenusClosed, and gating logic to allow controller-driven menu close actions; it is concise and on-topic though the word "fix" is repeated. The title gives a clear signal to reviewers about the main behavioral fix implemented by the PR.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Using provided base ref: bfafeff
Using base ref: bfafeff
Base commit date: 2025-09-22T00:39:30+01:00 (Monday, September 22, 2025 12:39 AM)
No actionable suggestions for changed features.

[Copilot]

Pull Request Overview

Fixes an issue where the VR overlay could not be exited using controllers if Skyrim UI menus weren't reported open.

• Centralizes and caches the UI "menu open" check in uiMenusOpen.
• Introduces allowWhenUIMenusClosed to selectively allow close actions when the VR menu is enabled but game UI menus are closed, and gates mapping execution via onlyAllowClose.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Features/VR.cpp (2)

1569-1578: Policy flag is a clean extensibility point.

allowWhenUIMenusClosed makes intent explicit and keeps mappings declarative. Consider tiny perf polish later (e.g., preallocating mappings) but not required for this PR.

---

1644-1648: Gate only “closers” when UI menus are closed — consider overlay close too.

onlyAllowClose = isEnabled && !uiMenusOpen properly restricts actions. If desired UX is to also allow closing the VR overlay in this state, mark that mapping as allowed as well.

Apply if you want overlay-close parity:

-        { [&]() {
-             return CheckCombo(settings.VROverlayCloseKeys) && overlayEnabled;
-         },
-            [&]() { overlayEnabled = false; } }
+        { [&]() {
+             return CheckCombo(settings.VROverlayCloseKeys) && overlayEnabled;
+         },
+            [&]() { overlayEnabled = false; },
+            true }

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bfafeff and ea3eb97.

📒 Files selected for processing (1)

• src/Features/VR.cpp (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{cpp,cxx,cc,c,h,hpp,hxx,hlsl,hlsli,fx,fxh,py}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Do not include TODO/FIXME placeholders; provide complete, working solutions

Files:

• src/Features/VR.cpp

src/**/*.{cpp,cxx,cc,h,hpp,hxx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/**/*.{cpp,cxx,cc,h,hpp,hxx}: Ensure SE/AE/VR runtime compatibility; use runtime detection patterns (e.g., REL::RelocateMember())
Include robust error handling and resource management with graceful degradation in the plugin code

Files:

• src/Features/VR.cpp

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build plugin and addons

🔇 Additional comments (3)

src/Features/VR.cpp (3)

1557-1565: Early UI-state evaluation is sound (enables close-when-no-UI).

Short-circuiting on globals::game::ui avoids NPEs, and inValidMenuState correctly allows processing when our menu is enabled but game menus are closed. LGTM.

---

1628-1630: Close mapping correctly allowed when UI menus are closed.

This matches the PR goal (exiting menu via controllers even when the game UI isn’t reporting an open menu). Good change.

---

1650-1652: Loop filter preserves one-action-per-frame.

Skipping non-allowed mappings under onlyAllowClose is correct and maintains deterministic behavior. LGTM.

[github-actions]

✅ A pre-release build is available for this PR:
Download