Skip to content

bug fix?: Hide UnitDisplay frame when all unit types are disabled - #1392

Merged
evanpelle merged 3 commits into
openfrontio:mainfrom
Aotumuri:fix-unit-display
Jul 18, 2025
Merged

evanpelle merged 3 commits into
openfrontio:mainfrom
Aotumuri:fix-unit-display

Conversation

@Aotumuri

@Aotumuri Aotumuri commented Jul 10, 2025 •

Copy link
Copy Markdown
Member

Description:

This PR updates the UnitDisplay component so that when all unit types (City, Factory, Port, Defense Post, Missile Silo, SAM Launcher) are disabled in the game config, the UI frame itself will also be hidden.

This is a box that shows how many and what types of units the player currently owns.
There’s a feature where, if unit types are disabled in the settings, the corresponding parts of the UI will disappear.

However, if all unit types are disabled, for some reason the outer container still remains visible.
While this might not be a critical issue, I feel it’s unnecessary and redundant, so I’d like to remove it.

Alternatively, we could consider keeping the box as a kind of placeholder to indicate that some kind of menu might appear there.
But since it serves no purpose during gameplay in that state, I think it would just be meaningless UI.

before
スクリーンショット 2025-07-10 12 49 37
スクリーンショット 2025-07-10 12 49 47

after
スクリーンショット 2025-07-10 12 48 08

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced
  • I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors

Please put your Discord username so you can be contacted if a bug or regression is found:

aotumuri

@coderabbitai

coderabbitai Bot commented Jul 10, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The UnitDisplay class was updated to add a private boolean property allDisabled that checks if all main unit types are disabled in the game settings. The render() method now returns null early if allDisabled is true, skipping the unit display rendering.

Changes

File(s) Change Summary
src/client/graphics/layers/UnitDisplay.ts Added private property allDisabled initialized in init(). Updated render() to return null if all units are disabled.

Possibly related PRs

Suggested reviewers

  • evanpelle

Poem

When all the units take a rest,
No cities, ports, or silos left,
The display stays quiet, nothing to show—
A peaceful screen where units don’t go.
Code checks the rules, then slips away,
Waiting for another day!
🚦🛑

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-14T08_04_44_467Z-debug-0.log


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5bfc15c and 1684faa.

📒 Files selected for processing (1)
  • src/client/graphics/layers/UnitDisplay.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/client/graphics/layers/UnitDisplay.ts
⏰ 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

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Aotumuri Aotumuri changed the title Hide UnitDisplay frame when all unit types are disabled bug fix?: Hide UnitDisplay frame when all unit types are disabled Jul 10, 2025
@Aotumuri Aotumuri self-assigned this Jul 11, 2025
@Aotumuri Aotumuri added Bug UI/UX UI/UX changes including assets, menus, QoL, etc. labels Jul 11, 2025
Comment on lines +93 to +99
const allDisabled =
config.isUnitDisabled(UnitType.City) &&
config.isUnitDisabled(UnitType.Factory) &&
config.isUnitDisabled(UnitType.Port) &&
config.isUnitDisabled(UnitType.DefensePost) &&
config.isUnitDisabled(UnitType.MissileSilo) &&
config.isUnitDisabled(UnitType.SAMLauncher);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cache this boolean since it cannot change during the game

@Aotumuri Aotumuri added this to the v24 milestone Jul 15, 2025
@CLAassistant

CLAassistant commented Jul 16, 2025 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@drillskibo

Copy link
Copy Markdown
Contributor

Can @openfrontio/core-contributor do a final pass and resolve pending changes so that it can be merged?

@drillskibo
drillskibo requested a review from scottanderson July 18, 2025 04:33

@drillskibo drillskibo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm with cache functionality.

@evanpelle evanpelle left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@github-project-automation github-project-automation Bot moved this from Triage to Final Review in OpenFront Release Management Jul 18, 2025
@evanpelle
evanpelle merged commit 2292993 into openfrontio:main Jul 18, 2025
@github-project-automation github-project-automation Bot moved this from Final Review to Complete in OpenFront Release Management Jul 18, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Sep 21, 2025
4 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug UI/UX UI/UX changes including assets, menus, QoL, etc.

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

5 participants