Princess Intelligent Hidden Unit Reveal #7812
Draft
+831
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary
This PR adds intelligent hidden unit reveal behavior to the Princess bot. Previously, hidden units would never voluntarily reveal themselves - they would stay hidden forever until an enemy stumbled into Point Blank Shot range. Now Princess evaluates firing opportunities and reveals when expected damage justifies breaking concealment.
Changes
Core Feature
- New behavior setting: hiddenUnitRevealIndex (0-10 scale)
- 0 = Never reveal (original behavior)
- 5 = Moderate (default)
- 10 = Always reveal if any target exists
- Decision formula: reveal if (expectedDamage / selfPreservation) >= threshold
- Princess calculates best firing plan for hidden units and reveals when the damage opportunity is worth it
Files Modified
| File | Changes |
|------------------------------|-----------------------------------------------------------------------------|
| BehaviorSettings.java | Added HIDDEN_REVEAL_VALUES array, field, getters/setters, XML serialization |
| BehaviorSettingsFactory.java | Configured predefined behaviors (BERSERK=9, COWARDLY=1, CONVOY=0, etc.) |
| Princess.java | Added shouldRevealHiddenUnit() method, modified calculateFiringTurn() |
| BotConfigDialog.java | Added UI slider for hidden unit reveal setting |
| messages.properties | Added i18n strings for UI |
New Files
| File | Purpose |
|--------------------|---------------------------------------------------------|
| RevealCommand.java | Chat command to force reveal all hidden units (testing) |
Diagnostic Logging
Added detailed logging to help diagnose arc/facing issues:
- Logs twist requirements, facing, canChangeSecondaryFacing, alreadyTwisted
- Logs when TorsoTwistAction is sent
- Warns if plan expects twist but no action generated
Predefined Behavior Values
| Behavior | hiddenUnitRevealIndex | Reasoning |
|----------|-----------------------|-------------------------------|
| DEFAULT | 5 | Balanced |
| BERSERK | 9 | Very aggressive |
| COWARDLY | 1 | Very conservative |
| ESCAPE | 2 | Focus on escaping |
| RUTHLESS | 7 | Tactical but aggressive |
| PIRATE | 8 | Opportunistic |
| CONVOY | 0 | Never reveal, focus on moving |
Testing
New chat command for testing:
Princess: reveal
Forces all hidden Princess units to reveal immediately.
Known Limitations
- Reveals during firing phase rather than start of movement phase (slight deviation from strict RAW)
- Future enhancement: "reveal to relocate" when enemies are too far away (deferred)
How to Test
1. Create game with hidden unit rules enabled
2. Deploy Princess-controlled unit as hidden
3. Position enemy units at various ranges
4. Observe Princess's reveal decisions based on behavior settings
5. Use Princess: reveal command to force reveal for debugging
6. Check unified_log.log for detailed decision logging
HammerGS
added
Princess/AI
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds intelligent hidden unit reveal behavior to the Princess bot, allowing hidden units to evaluate firing opportunities and reveal themselves when expected damage justifies breaking concealment. Previously, hidden units would never reveal voluntarily.
Key changes:
- New
hiddenUnitRevealIndexbehavior setting (0-10 scale) with configurable thresholds - Decision logic that compares
expectedDamage / selfPreservationagainst threshold to determine whether to reveal - UI slider in bot configuration dialog for adjusting reveal willingness
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| BehaviorSettings.java | Adds HIDDEN_REVEAL_VALUES array, getters/setters, XML serialization, equals/hashCode for the new reveal index setting |
| BehaviorSettingsFactory.java | Configures reveal index values for predefined behaviors (BERSERK=9, COWARDLY=1, CONVOY=0, etc.) |
| Princess.java | Adds shouldRevealHiddenUnit() decision logic, modifies calculateFiringTurn() to check reveal conditions, adds diagnostic logging for twist/facing issues |
| BotConfigDialog.java | Adds UI slider for hidden unit reveal setting with proper initialization and change detection |
| RevealCommand.java | New chat command to force reveal all hidden units for testing/debugging purposes |
| ChatCommands.java | Registers the new REVEAL command with abbreviation "rv" |
| messages.properties | Adds i18n strings for UI slider labels, tooltips, and command description |
| log4j2.xml | Changes bot logging level from error to debug (should be reverted before merge) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| Issue | File | Fix | |-------------------------------------|---------------------------|-------------------------------------------------------------------------------| | Critical: Logging level debug→error | log4j2.xml:61 | Reverted megamek.client.bot from "debug" to "error" | | Diagnostic logging info→debug | Princess.java:1006,1124 | Changed twist/facing diagnostics to LOGGER.debug() | | Unused parameter (CodeQL) | Princess.java:4061 | Removed unused shooter param from hasAnyValidTarget() | | Comment clarity | BehaviorSettings.java:129 | Changed "minimum damage ratio" to "(expectedDamage / selfPreservation) ratio" | | Comment clarity | BehaviorSettings.java:141 | Changed "if any damage possible" to "if any target
IllianiBird
requested changes
Dec 18, 2025
Collaborator
IllianiBird
left a comment
IllianiBird
left a comment
There was a problem hiding this comment.
One tiny comment, once resolved this looks good to merge
| Issue | Fix Applied | |--------------------------------------------------|-------------------------------------------------------------------| | IllianiBird: Remove "(current behavior)" | ✅ BehaviorSettings.java:131 - removed annotation | | Copilot: Debug logging left in | ✅ log4j2.xml:68 - changed megamek logger from "debug" to "error" | | Copilot: Twist/facing diagnostics at wrong level | ✅ Already at debug level - no change needed | | Copilot: Unused shooter parameter | ✅ Method already doesn't have this parameter - no change needed |
Enhances Princess's hidden unit reveal decision with damage trend analysis:
- Track expected damage history per hidden unit (last 7 rounds)
- Analyze trend direction (increasing/peaked/declining)
- Apply trend multiplier to reveal threshold:
- 0.75x at peak (easier to reveal - best moment to strike)
- 0.85x when declining (opportunity fading, don't wait)
- 1.25x when increasing below 60% (wait for better shot)
- 1.1x when increasing above 60% (getting close to peak)
Debug logging improvements:
- Add enemy detection logging in EnemyTracker (NEW/UPDATE/LOST)
- Add visible enemies list at start of firing phase
- Log trend analysis details (history size, peak, ratio, direction)
- Include trendMultiplier in reveal evaluation output
- Suppress verbose Precognition lock logging to reduce noise
Files changed:
- Princess.java: Trend tracking logic and reveal decision integration
- EnemyTracker.java: Enemy detection logging
- log4j2.xml: Logging configuration for Princess debug output
…Unit-Reveal' into Fix-Princess-Intelligent-Hidden-Unit-Reveal
Changes Made:
1. BotClient.java - Added PREMOVEMENT phase handling:
case PREMOVEMENT:
evaluateHiddenUnitRepositioning();
sendDone(true);
break;
Plus a default empty implementation that subclasses can override.
2. Princess.java - Added reposition evaluation logic:
| Method | Purpose |
|-------------------------------------------|-----------------------------------------------------------------------------------------|
| evaluateHiddenUnitRepositioning() | Main entry point - evaluates all hidden units during PREMOVEMENT |
| evaluateHiddenUnitForRepositioning() | Evaluates single hidden unit for reposition potential |
| calculateDamageFromCurrentPosition() | Gets expected damage from current position |
| generateRepositionCandidates() | Generates candidate positions within movement range |
| calculateEnemyCenter() | Finds center of enemy positions for facing calculation |
| calculateDamageFromHypotheticalPosition() | Calculates damage from a hypothetical position using EntityState + Builder.buildGuess() |
How It Works:
1. During PREMOVEMENT phase, Princess evaluates each hidden unit
2. Calculates expected damage from current position (with torso twist)
3. Generates candidate positions within walk MP range
4. For each candidate, calculates expected damage from that position
5. If best reposition damage > 2x current damage, marks unit to reveal at movement start
6. Unit reveals at start of MOVEMENT phase, then can move normally
Debug Logging:
Hidden unit Akuma reposition evaluation: currentDamage=3.50, bestRepositionDamage=45.00, threshold=2.0, bestPosition=(1805)
Hidden unit Akuma will reveal to reposition: (2103) -> (1805) (damage: 3.5 -> 45.0)
This completes the intelligent hidden unit reveal feature set for PR #7812.
Member
Author
Not ready for prime time yet. Is working but needs more tweaks. |
Member
We should probably set this back to Draft then so it doesn't get accidentally merged before the tests are ready. |
HammerGS
added
the
For New Dev Cycle
HammerGS
removed
the
For New Dev Cycle
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds intelligent hidden unit reveal behavior to the Princess bot. Previously, hidden units would never voluntarily reveal themselves - they would stay hidden forever until an enemy stumbled into Point Blank Shot range. Now Princess evaluates firing opportunities and reveals when expected damage justifies breaking concealment.
Changes
Core Feature
Files Modified
New Files
Diagnostic Logging
Added detailed logging to help diagnose arc/facing issues:
Predefined Behavior Values
Testing
New chat command for testing:
Princess: reveal
Forces all hidden Princess units to reveal immediately.
Known Limitations
How to Test