Add game option to show allied intel in strategic overlay#7054
Add game option to show allied intel in strategic overlay#7054Garanas wants to merge 3 commits intoFAForever:developfrom
Conversation
📝 WalkthroughWalkthroughThis change adds a new feature enabling players to display allied intel in the strategic overlay. The implementation includes a changelog entry documenting the feature, a new UI option with three toggleable states, and corresponding tooltip help text to guide users through the Interface menu. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@changelog/snippets/feature.7054.md`:
- Around line 1-3: Replace the freeform text in
changelog/snippets/feature.7054.md with the repository's changelog snippet
template used by other files in changelog/snippets: add the required
front-matter fields (e.g., pull_request: 7054, type: feature, and relevant
category/area keys) then a short description body summarizing the change ("Add
ability to show allied intel in strategic overlay" and the default behavior and
UI location). Use the same YAML/front-matter keys and format as the other
snippets in changelog/snippets so the docs pipeline accepts it.
In `@lua/ui/help/tooltips.lua`:
- Around line 854-857: Rename the tooltip entry key to match the option key so
automatic lookup works: change options_show_allied_intel_in_strategic_overlay to
intel_overlay_allies while keeping the title and description values unchanged;
update the tooltip table entry (the object containing title and description) to
use intel_overlay_allies so it matches the option mapping used elsewhere.
| - (#7054) Add ability to show allied intel in strategic overlay | ||
|
|
||
| By default the intel of allied structures is shared. This default is chosen to make players aware of the new features without cluttering the screen. The game option can be found under Interface -> HUD. |
There was a problem hiding this comment.
Fix changelog snippet format to unblock CI.
The docs pipeline already fails on this file with “Invalid format for changelog file”. Please rewrite this snippet to the repository’s expected changelog snippet template (same format as other files in changelog/snippets).
🧰 Tools
🪛 GitHub Actions: Documentation - Generate changelog
[error] 1-1: Changelog verification failed: Invalid format for changelog file.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@changelog/snippets/feature.7054.md` around lines 1 - 3, Replace the freeform
text in changelog/snippets/feature.7054.md with the repository's changelog
snippet template used by other files in changelog/snippets: add the required
front-matter fields (e.g., pull_request: 7054, type: feature, and relevant
category/area keys) then a short description body summarizing the change ("Add
ability to show allied intel in strategic overlay" and the default behavior and
UI location). Use the same YAML/front-matter keys and format as the other
snippets in changelog/snippets so the docs pipeline accepts it.
| options_show_allied_intel_in_strategic_overlay = { | ||
| title = "<LOC Show_Allied_Intel_Title>Show Allied Intel in Strategic Overlay", | ||
| description = "<LOC Show_Allied_Intel_Description>Toggles the display of allied intel in the strategic overlay.", | ||
| }, |
There was a problem hiding this comment.
Tooltip key name does not match the option key mapping.
Line 854 uses options_show_allied_intel_in_strategic_overlay, but the option key is intel_overlay_allies. With the current naming pattern, this prevents automatic tooltip lookup for the new option.
[suggested fix]
Rename tooltip key to match the option key
-options_show_allied_intel_in_strategic_overlay = {
+options_intel_overlay_allies = {
title = "<LOC Show_Allied_Intel_Title>Show Allied Intel in Strategic Overlay",
description = "<LOC Show_Allied_Intel_Description>Toggles the display of allied intel in the strategic overlay.",
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| options_show_allied_intel_in_strategic_overlay = { | |
| title = "<LOC Show_Allied_Intel_Title>Show Allied Intel in Strategic Overlay", | |
| description = "<LOC Show_Allied_Intel_Description>Toggles the display of allied intel in the strategic overlay.", | |
| }, | |
| options_intel_overlay_allies = { | |
| title = "<LOC Show_Allied_Intel_Title>Show Allied Intel in Strategic Overlay", | |
| description = "<LOC Show_Allied_Intel_Description>Toggles the display of allied intel in the strategic overlay.", | |
| }, |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@lua/ui/help/tooltips.lua` around lines 854 - 857, Rename the tooltip entry
key to match the option key so automatic lookup works: change
options_show_allied_intel_in_strategic_overlay to intel_overlay_allies while
keeping the title and description values unchanged; update the tooltip table
entry (the object containing title and description) to use intel_overlay_allies
so it matches the option mapping used elsewhere.
1 participant
Description of the proposed changes
Depends on: FAForever/FA-Binary-Patches#142
Testing done on the proposed changes
Change the game option and launch local multiplayer, observe that the changes are saved and applied.
Additional context
Supports the ability to show allied intel in strategic overlay, with thanks to the efforts of RutreD! Requires the exe that is posted on Zulip.
Checklist
Summary by CodeRabbit
Release Notes