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

fix: random caching error with UnitButtonObject #407

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

OH296
Copy link
Collaborator

@OH296 OH296 commented Jan 10, 2025

Description of changes

Reasons for changes

Related links

How have you tested your changes?

  • Compile
  • New game
  • Next turn
  • Space Travel
  • Ground Battle

Summary by Sourcery

Bug Fixes:

  • Fix a bug where the selected planet index could go out of bounds.

Copy link
Contributor

sourcery-ai bot commented Jan 10, 2025

Reviewer's Guide by Sourcery

This pull request fixes a caching error that occurred randomly within the UnitButtonObject. The fix involves changing how the UnitButtonObject updates its data. Instead of directly accessing the struct fields using struct_get_names, the code now iterates through the struct fields and updates the corresponding fields in the UnitButtonObject. Additionally, the pull request includes a change to reset the selecting_planet variable in the obj_star_select object under certain conditions and modifies how the hidden_cult variable is accessed.

File-Level Changes

Change Details Files
Fixed a caching error in the UnitButtonObject.
  • Changed the way UnitButtonObject updates its data to prevent random caching errors.
  • Iterates through the struct fields and updates the corresponding fields in the UnitButtonObject instead of directly accessing the struct fields using struct_get_names
scripts/scr_buttons/scr_buttons.gml
Reset the selecting_planet variable under specific conditions.
  • Added a conditional statement to reset the obj_controller.selecting_planet variable to 0 if it exceeds the target's planets value.
objects/obj_star_select/Draw_64.gml
Modified how the hidden_cult variable is accessed.
  • Changed the way the hidden_cult variable is determined by using planet_data to check for the Gene Stealer Cult feature and its hiding status, rather than directly accessing the planet's features array as before.
  • Moved the variable declaration outside of the with statement
objects/obj_star_select/Draw_64.gml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the PR: Fix This is a fix for a bug label Jan 10, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 10, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @OH296 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide a description of the caching issue that was occurring and explain how these changes fix it. The current changes (adding underscore prefix and declaring loop variable) don't obviously address a caching problem.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296
Copy link
Collaborator Author

OH296 commented Jan 10, 2025

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @OH296 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide a description of the caching error you encountered and how these changes fix it. This will help reviewers understand and verify the fix.
  • Please check the testing boxes that apply to indicate what testing has been performed on these changes.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296 OH296 merged commit b754136 into Adeptus-Dominus:release/0.10.0.0 Jan 10, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Fix This is a fix for a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant