adding "Force reclaim" hotkey #7002
Conversation
Engie will continue reclaiming even if both storages are full.
📝 WalkthroughWalkthroughThis PR introduces a force reclaim feature for game units. It adds a new callback handler that filters engineers from a selection and applies force reclaim state, complemented by key bindings and UI descriptions to enable/disable this functionality via keyboard shortcuts. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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
🤖 Fix all issues with AI agents
In `@lua/keymap/misckeyactions.lua`:
- Around line 560-562: The SetForceReclaim function always forces showMsg to
true because it uses "showMsg or true"; change the defaulting so only
nil/undefined becomes true and explicit false is preserved—modify the call
around SimCallback in SetForceReclaim to pass ShowMsg = (showMsg == nil) and
true or showMsg (or equivalent nil-coalescing logic) so that passing false
results in ShowMsg = false while nil still yields true; ensure you update the
symbol SetForceReclaim and its use of SimCallback accordingly.
In `@lua/SimCallbacks.lua`:
- Around line 829-858: The loop in Callbacks.ForceReclaim calls
unit:ForceReclaim which can be nil on deployments without the engine patch;
update the function to guard before invoking the method by checking the method
exists on each unit (or on the prototype) and only calling it when present—e.g.,
verify unit.ForceReclaim (or check the first engineer) before the for k, unit in
engineers loop and skip units lacking the method (optionally log or count
skipped units) to avoid a hard Lua error when ForceReclaim is unavailable.
| function SetForceReclaim(enable, showMsg) | ||
| SimCallback({ Func = 'ForceReclaim', Args = { Enable = enable, ShowMsg = showMsg or true} }, true) | ||
| end |
There was a problem hiding this comment.
showMsg default logic always forces true.
Passing false is ignored because showMsg or true always evaluates to true. If silent mode is expected, this breaks it.
✅ Proposed fix
function SetForceReclaim(enable, showMsg)
- SimCallback({ Func = 'ForceReclaim', Args = { Enable = enable, ShowMsg = showMsg or true} }, true)
+ local show = (showMsg ~= false)
+ SimCallback({ Func = 'ForceReclaim', Args = { Enable = enable == true, ShowMsg = show } }, true)
end📝 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.
| function SetForceReclaim(enable, showMsg) | |
| SimCallback({ Func = 'ForceReclaim', Args = { Enable = enable, ShowMsg = showMsg or true} }, true) | |
| end | |
| function SetForceReclaim(enable, showMsg) | |
| local show = (showMsg ~= false) | |
| SimCallback({ Func = 'ForceReclaim', Args = { Enable = enable == true, ShowMsg = show } }, true) | |
| end |
🤖 Prompt for AI Agents
In `@lua/keymap/misckeyactions.lua` around lines 560 - 562, The SetForceReclaim
function always forces showMsg to true because it uses "showMsg or true"; change
the defaulting so only nil/undefined becomes true and explicit false is
preserved—modify the call around SimCallback in SetForceReclaim to pass ShowMsg
= (showMsg == nil) and true or showMsg (or equivalent nil-coalescing logic) so
that passing false results in ShowMsg = false while nil still yields true;
ensure you update the symbol SetForceReclaim and its use of SimCallback
accordingly.
| do | ||
|
|
||
| ---@param data { Enable: boolean, ShowMsg: boolean } | ||
| ---@param selection Unit[] | ||
| Callbacks.ForceReclaim = function(data, selection) | ||
| -- verify selection | ||
| selection = SecureUnits(selection) | ||
| if (not selection) or TableEmpty(selection) then | ||
| return | ||
| end | ||
|
|
||
| -- verify we have engineers | ||
| local engineers = EntityCategoryFilterDown(categories.ENGINEER, selection) | ||
| if TableEmpty(engineers) then | ||
| return | ||
| end | ||
|
|
||
| for k, unit in engineers do | ||
| unit:ForceReclaim(data.Enable) | ||
| end | ||
|
|
||
| if data.ShowMsg then | ||
| if data.Enable == true then | ||
| print(string.format("Force reclaim ENABLED for %d engineers", table.getn(engineers))) | ||
| else | ||
| print(string.format("Force reclaim DISABLED for %d engineers", table.getn(engineers))) | ||
| end | ||
| end | ||
| end | ||
| end |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for ForceReclaim references in the codebase
rg -i "forcereclaim" --type lua -B 2 -A 2Repository: FAForever/fa
Length of output: 2057
🏁 Script executed:
#!/bin/bash
# Check for similar patterns where methods are called on units in SimCallbacks
rg "unit:" lua/SimCallbacks.lua -A 1 | head -50Repository: FAForever/fa
Length of output: 582
🏁 Script executed:
#!/bin/bash
# Look for defensive checks or error handling patterns in SimCallbacks
rg "and.*\." lua/SimCallbacks.lua | head -20Repository: FAForever/fa
Length of output: 1653
🌐 Web query:
FAForever FA-Binary-Patches PR 130 ForceReclaim
💡 Result:
FAForever FA-Binary-Patches PR #130 is titled “sim Unit:ForceReclaim(bool)” and is currently Open (opened Jan 23, 2026) by Strogoo. [1]
What it does:
- Adds a new Lua-exposed unit API:
Unit:ForceReclaim(bool). - Purpose: when enabled, engineers continue reclaiming even if storage is full. [2]
Implementation notes (high level):
- Introduces new assembly hooks and C++ support files to store/check a per-unit “force reclaim” flag and expose it to Lua. [2]
CI / review status:
- CodeRabbit shows 1 passed check (title), and 2 warnings (missing template sections in description; docstring coverage below threshold). [2]
Sources: PR list page [1], PR #130 conversation/details [2].
🏁 Script executed:
#!/bin/bash
# Check if there are other guards for patch-dependent features in similar callbacks
rg "WARN|error|if not.*then.*return" lua/SimCallbacks.lua -B 2 -A 2 | head -40Repository: FAForever/fa
Length of output: 1403
🏁 Script executed:
#!/bin/bash
# Search for any documentation or comments about patch dependencies in the codebase
rg -i "patch|binary|binary-patch|forcereclaim" lua/ --type lua | grep -i "comment\|--\|doc"Repository: FAForever/fa
Length of output: 6192
Guard against missing ForceReclaim method to prevent sim crash.
unit:ForceReclaim() will cause a hard Lua error if the engine patch isn't present, since the method will be nil. This is a real risk given that FA-Binary-Patches PR #130 (which adds this method) is currently open and not yet deployed. Add a defensive check before the loop to prevent crash on mismatched deployments.
Suggested fix
+ if not (engineers[1] and engineers[1].ForceReclaim) then
+ WARN("Force reclaim is unavailable. Verify the FA-Binary-Patches update is deployed.")
+ return
+ end
+
for k, unit in engineers do
unit:ForceReclaim(data.Enable)
end🤖 Prompt for AI Agents
In `@lua/SimCallbacks.lua` around lines 829 - 858, The loop in
Callbacks.ForceReclaim calls unit:ForceReclaim which can be nil on deployments
without the engine patch; update the function to guard before invoking the
method by checking the method exists on each unit (or on the prototype) and only
calling it when present—e.g., verify unit.ForceReclaim (or check the first
engineer) before the for k, unit in engineers loop and skip units lacking the
method (optionally log or count skipped units) to avoid a hard Lua error when
ForceReclaim is unavailable.
1 participant
Engie will continue reclaiming even if both storages are full.
Additional context
requiers FAForever/FA-Binary-Patches#130
1.mp4
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.