Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Starkku's pip additions: Empty frame for Tiberiums #1138

Merged
merged 9 commits into from
Feb 26, 2024

Conversation

Fryone
Copy link
Contributor

@Fryone Fryone commented Aug 25, 2023

Pips.Tiberiums.Frames=0,2,5,2,2 - added first int to be empty frame for tiberiums
image

Summary by CodeRabbit

  • Chores
    • Removed "visualstudioexptteam.vscodeintellicode" from the recommended extensions list.
  • Documentation
    • Updated documentation for customizing pips for Storage and Tiberium types.
  • New Features
    • Improved visual representation of Tiberium pips in the game.

@github-actions
Copy link

github-actions bot commented Aug 25, 2023

Nightly build for this pull request:

This comment is automatic and is meant to allow guests to get latest nightly builds for this pull request without registering. It is updated on every successful build.

@MortonPL MortonPL added the Minor Documentation is not required label Aug 31, 2023
src/Ext/Techno/Hooks.Pips.cpp Outdated Show resolved Hide resolved
src/Ext/Techno/Hooks.Pips.cpp Outdated Show resolved Hide resolved
@Starkku
Copy link
Contributor

Starkku commented Aug 31, 2023

I personally think the empty frame should be defined separately since this is how it currently works on the techno-specific Pip keys (and in a manner of speaking, for shield etc. pips since the pip board can be set separately) but this is a very minor gripe and ultimately W/E.

separated empty frame from the list
Copy link

coderabbitai bot commented Nov 13, 2023

Walkthrough

The update primarily focuses on refining the visual representation and configuration of Tiberium pips within the game. It includes removing an unnecessary extension from the development environment, adjusting the default settings and display order for Tiberium pips, and enhancing the code to better manage these visual elements. The modifications span across documentation, configuration files, and source code to ensure a more customizable and visually appealing depiction of Tiberium-related elements.

Changes

Files Change Summary
.vscode/extensions.json Removed "visualstudioexptteam.vscodeintellicode" extension
docs/Fixed-or-Improved-Logics.md
rulesmd.ini
Updated default values and display order for Tiberium pips; Moved configurations from [AudioVisual] to rulesmd.ini
src/Ext/Rules/Body.cpp
src/Ext/Rules/Body.h
Added Pips_Tiberiums_EmptyFrame data member for Tiberium pips visualization
src/Ext/Techno/Hooks.Pips.cpp Improved Tiberium pips drawing logic using new configuration values

🐇✨
In the realm of code and pixel sprites,
A change was made to bring delights.
Tiberium's glow, now finer in sight,
With pips arranged, oh what a sight!
Farewell to clutter, hello to grace,
In the digital garden, we embrace.
🌿🎮

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit-tests for this file.
  • 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 generate unit tests for this file.
    • @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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 53d754c and 06ff312.
Files selected for processing (5)
  • .vscode/extensions.json (1 hunks)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
  • src/Ext/Rules/Body.cpp (2 hunks)
  • src/Ext/Rules/Body.h (2 hunks)
  • src/Ext/Techno/Hooks.Pips.cpp (2 hunks)
Files skipped from review due to trivial changes (2)
  • .vscode/extensions.json
  • src/Ext/Rules/Body.h
Additional comments: 5
src/Ext/Rules/Body.cpp (2)
  • 98-104: The new INI setting Pips.Tiberiums.EmptyFrame is correctly loaded from the INI file. This change aligns with the pull request's goal to enhance the visual representation of Tiberium pips. Ensure that the default value for this setting is documented and that it does not conflict with existing frame indices.

  • 233-239: The serialization process has been updated to include the new Pips_Tiberiums_EmptyFrame variable. This is necessary to ensure that the new setting is saved and loaded correctly. Verify that the serialization process is tested and that the new setting is correctly handled during save/load operations.

docs/Fixed-or-Improved-Logics.md (2)
  • 540-545: The documentation correctly reflects the new configuration options for Tiberium pips, including the addition of an empty frame. This change should be verified in the actual INI files to ensure the default values are set as described here.

---start hunk 1---

  • 550-555: The documentation update is clear and provides the necessary information for modders to understand the new configuration options for Tiberium pips. It's important to ensure that the rulesmd.ini file is updated accordingly to support these new features.
src/Ext/Techno/Hooks.Pips.cpp (1)
  • 177-182: ```
    ---end hunk 0---
    The initialization of frame with `Pips_Tiberiums_EmptyFrame` is correct, ensuring that if no Tiberium is present, the empty frame is used.

---start hunk 1---



</blockquote></details></blockquote></details>



</details>

src/Ext/Techno/Hooks.Pips.cpp Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 06ff312 and 71dcb03.
Files selected for processing (4)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
  • src/Ext/Rules/Body.cpp (2 hunks)
  • src/Ext/Rules/Body.h (2 hunks)
  • src/Ext/Techno/Hooks.Pips.cpp (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/Ext/Techno/Hooks.Pips.cpp
Additional comments: 6
src/Ext/Rules/Body.h (2)
  • 68-68: The new member variable Pips_Tiberiums_EmptyFrame is correctly added to the RulesExt class. It is initialized with a default value of 0, which is consistent with the pull request summary stating that the empty frame should be the first integer value in the sequence.

  • 139-139: The constructor of ExtData is updated to initialize the new member variable Pips_Tiberiums_EmptyFrame with a default value of 0. This is in line with the changes described in the pull request summary.

src/Ext/Rules/Body.cpp (2)
  • 99-105: The new INI setting Pips.Tiberiums.EmptyFrame is correctly loaded from the INI file. This change should be cross-checked with the documentation and in-game behavior to ensure that the new frame index is being applied correctly to the Tiberium pips visualization.

  • 238-243: The serialization of the new Pips_Tiberiums_EmptyFrame setting is included, which ensures that the value is saved and loaded correctly. This is important for maintaining game settings consistency across sessions.

docs/Fixed-or-Improved-Logics.md (2)
  • 562-567: The changes to Pips.Tiberiums.Frames and Pips.Tiberiums.DisplayOrder are significant for the visual representation of Tiberium storage on units. The addition of an empty frame at the beginning of the Pips.Tiberiums.Frames list is a notable change that should be reflected in the game's UI. It is important to ensure that the game's logic for displaying Tiberium pips is updated to accommodate this new frame sequence. Additionally, the change in the configuration file location from [AudioVisual] to rulesmd.ini should be verified to ensure that it does not conflict with any existing settings or mods that may rely on the previous configuration location.

  • 572-577: The changes to the Pips.Generic.Buildings.Size, Pips.Ammo.Size, Pips.Ammo.Buildings.Size, Pips.Tiberiums.Frames, and Pips.Tiberiums.DisplayOrder settings are refinements that affect how various pips are displayed in the game. It is important to verify that these changes are consistent with the intended visual design and that they do not introduce any unexpected behavior in the display of pips for different Tiberium types, ammo, and generic pips for buildings and units. The use of specific frames for different Tiberium types and the order of display should be carefully reviewed to ensure they meet the game's design requirements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 71dcb03 and 645ebc5.
Files selected for processing (1)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
Additional comments: 1
docs/Fixed-or-Improved-Logics.md (1)
  • 563-567: The documentation correctly reflects the changes made to the Pips.Tiberiums.Frames configuration, including the addition of an empty frame first and the adjustment of the order of Tiberium type pips. This aligns with the PR objectives and the AI-generated summary of changes.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 645ebc5 and 53fb90c.
Files selected for processing (1)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
Additional comments: 1
docs/Fixed-or-Improved-Logics.md (1)
  • 565-571: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [568-578]

The documentation has been updated to reflect the new default values and behavior for Pips.Tiberiums.Frames and Pips.Tiberiums.DisplayOrder. This aligns with the PR objectives to enhance the visual representation of Tiberium pips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 53fb90c and 88d874e.
Files selected for processing (1)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
Additional comments: 1
docs/Fixed-or-Improved-Logics.md (1)
  • 567-573: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [570-580]

The addition of Pips.Tiberiums.Frames and Pips.Tiberiums.DisplayOrder to the documentation reflects the changes made to the configuration settings for Tiberium pips. This update should provide users with the necessary information to customize the pip frames and their display order for different Tiberium types, enhancing the visual customization capabilities of the game.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 88d874e and 46e8433.
Files selected for processing (3)
  • docs/Fixed-or-Improved-Logics.md (2 hunks)
  • src/Ext/Rules/Body.cpp (2 hunks)
  • src/Ext/Rules/Body.h (2 hunks)
Additional comments: 2
src/Ext/Rules/Body.h (1)
  • 71-71: The addition of Pips_Tiberiums_EmptyFrame with an initialization value of 0 is aligned with the PR's objectives to enhance Tiberium pip customization. However, consider Starkku's suggestion to define the empty frame separately for consistency with other techno-specific pip keys.
src/Ext/Rules/Body.cpp (1)
  • 245-245: The addition of Pips_Tiberiums_EmptyFrame to the serialization process is correctly implemented and necessary for the new feature's functionality. This ensures that the customization options for Tiberium pips are correctly saved and loaded across game sessions.

docs/Fixed-or-Improved-Logics.md Show resolved Hide resolved
Copy link
Contributor

@Starkku Starkku left a comment

Choose a reason for hiding this comment

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

Fixed the documentation to reflect the actual additions. Looks good to go so merging.

@Starkku Starkku merged commit db55d1e into Phobos-developers:develop Feb 26, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Minor Documentation is not required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants