fix: Garrison fixes and minor changes

[MCPO-Spartan-117]

Description of changes

• Add some debug code and another disposition chart item, disallow garrisons from making disposition going into the negatives and flip a comparison.

Reasons for changes

• Garrisons could make relations go into the negative which could take forever to get out and with the incorrect comparison direction would take away relations if the charsima check failed and relations with the faction owner was higher.

How have you tested your changes?

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

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements several fixes for the garrison system by updating the disposition description logic with added debug checks, adjusting the garrison report logic based on planet owner, refining charisma test handling to adjust disposition changes, and adding safeguards to avoid unexpected disposition values in PlanetData. The changes aim to prevent negative disposition values and ensure consistent behavior during edge cases.

File-Level Changes

Change	Details	Files
Enhanced the disposition description chart with debug checks and additional range labels.	Inserted a debug message for disposition values lower than -100. Introduced an 'Extremely Hostile' label for disposition values from -100 up to 0. Added a debug check for disposition values higher than 100.	scripts/scr_garrison/scr_garrison.gml
Adjusted GarrisonForce reporting logic based on planet ownership.	Changed condition to check if the planet owner is not the player to decide on using the disposition description chart. Added an alternate message when the planet owner is the player and the disposition is below -1000. Logged a debug message in cases where the planet owner check fails.	scripts/scr_garrison/scr_garrison.gml
Refined charisma test handling and disposition change calculation.	Validated the garrison leader structure before testing for the 'honorable' trait. Added logging for cases where the garrison leader is missing. Adjusted the calculation for disposition change based on comparisons between planet disposition and faction disposition, applying clamps when necessary.	scripts/scr_garrison/scr_garrison.gml
Implemented safeguards in PlanetData to clamp disposition values.	Reset negative disposition values to -100 for non-player owned planets when in a specific range. Capped disposition values at 100 when they exceed this maximum.	scripts/scr_PlanetData/scr_PlanetData.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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @MCPO-Spartan-117 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider centralizing the repeated disposition clamping logic (e.g. for values below 0 and above 100) into a dedicated helper function to reduce duplication.
• Clarify the threshold conditions in the charisma test adjustments, as the combined comparisons and use of abs() could benefit from explicit explanation for maintainability.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[OH296]

I'm good with this few questions that may need resolving though. Most likely i think reverting that hard minimum of 0 to -100 should be sufficient though

[Blogaugis]

I don't see any issues at the first glance, so here's my approval.

[MCPO-Spartan-117]

@sourcery-ai review

[sourcery-ai]

Hey @MCPO-Spartan-117 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Clarify the conditional logic in the charisma test block of GarrisonForce, especially around the adjustment of dispo_change when nearing the -100 and 100 boundaries.
• Explain or refactor the disposition clamping values in PlanetData to make the intended thresholds and special cases more transparent.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟡 Security: 1 issue found
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[MCPO-Spartan-117]

@sourcery-ai review

[sourcery-ai]

Hey @MCPO-Spartan-117 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider unifying numeric boundaries for disposition values across the code to ensure consistency between debug messages and value adjustments.
• Remove or conditionally compile debug logs and commented-out branches so that production code is cleaner and more maintainable.

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

In these changes, a new conditional logic block has been integrated into the PlanetData constructor. The code now checks if a planet’s disposition value is negative but greater than -1000 and confirms that the planet’s owner is not the player faction; if so, the disposition is set to -100. Additionally, any disposition exceeding 100 is capped at 100. In the garrison module, modifications have been made to the disposition_description_chart function to handle extreme disposition values by outputting debug messages for values outside the expected range, and the descriptor for non-positive values has been updated to "Extremely Hostile." The GarrisonForce function has also been adjusted to change the conditional checking of planet ownership, add debug messaging in failure cases, and refine the computation of disposition changes based on the charisma test and disposition limits. No changes were made to exported or public entity declarations.

Suggested reviewers

• OH296

---

📜 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 655ebdd and f15b7a8.

📒 Files selected for processing (2)

• scripts/scr_PlanetData/scr_PlanetData.gml (1 hunks)
• scripts/scr_garrison/scr_garrison.gml (3 hunks)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code 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 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 generate unit testing code.
  • @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.

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 docstrings to generate docstrings for this PR. (Beta)
• @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 or @coderabbitai title 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.