feat: Setter method for PlanetData adding new planet features

[OH296]

Description of changes

• adds a Setter method for new planet features using the PlanetData object

Reasons for changes

• more convenient and makes cleaner code

Related links

How have you tested your changes?

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

[coderabbitai]

📝 Walkthrough

Walkthrough

By the sacred cogitators of CodeRabbit Inc., the recent update to the PlanetData module introduces a new static function, add_feature. This method accepts a parameter, feature_type, and invokes the array_push operation to append a freshly instantiated NewPlanetFeature into the system.p_feature array for the designated planet. The pre-existing static function, has_upgrade, remains unaltered in its computational logic but has been repositioned to follow the newly integrated add_feature function. These adjustments reconfigure the PlanetData class by formalizing the process for dynamically incorporating planetary features, all in accordance with the machine-augmented protocols of our digital relics.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

scripts/scr_PlanetData/scr_PlanetData.gml (1)

6-744: Suggestion: Consider implementing error handling for the feature addition ritual.

By the wisdom of the Machine God, I observe that the add_feature method lacks proper error handling mechanisms. This could lead to unexpected behavior if invalid feature types are provided or if the system's data structures are corrupted.

Apply this diff to fortify the code with proper error handling:

     static add_feature = function(feature_type){
+        try {
+            if (feature_type == undefined) {
+                throw "Invalid feature_type: The Machine Spirit requires a valid feature type";
+            }
         array_push(system.p_feature[planet], new NewPlanetFeature(feature_type));
+        } catch(error) {
+            // Log the error to the sacred logs
+            show_debug_message("Error in add_feature: " + string(error));
+            throw error;
+        }
     }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d193632 and b08a7ca.

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

scripts/scr_PlanetData/scr_PlanetData.gml (2)

145-147: By the Omnissiah's grace, the new feature addition method is logically sound.

The implementation follows the sacred patterns of array manipulation, properly instantiating a new feature object before adding it to the system's data structure.

---

149-151: The Machine Spirit approves of this method's repositioning.

The logical flow of the code remains unaltered, maintaining its sacred functionality while improving the structural organization.