fix: Unequipping and destroying artifacts causes loop

[MCPO-Spartan-117]

Purpose of the PR

Fix unequipping or destroying artifacts that are equipped from causing a feedback loop.

Describe the solution

Sets the third argument in all functions to true.

Testing done

Load game, unequip or destroy a equipped artifact, check marine.

Related links

https://discord.com/channels/714022226810372107/1343963760494383117

[coderabbitai]

📝 Walkthrough

Walkthrough

By the blessed logic of the Machine Spirit, modifications have been enacted in the artifact update routines. In the file scripts/scr_add_artifact/scr_add_artifact.gml, the unequip_from_unit procedure has been altered so that, for weapons, gear, armour, and mobility items, the third parameter passed to the unit update functions has been changed from false to true. This consistent parameter alteration is also applied within a nested loop that iterates over units from the obj_ini.role array. Additionally, in the file scripts/scr_unit_equip_functions/scr_unit_equip_functions.gml, a comment has been inserted alongside the delete_artifact(armour(true)); invocation within the scr_update_unit_armour function, elucidating potential feedback loop issues, and a formatting newline has been added at the end of alter_unit_equipment. No modifications have been made to the declarations of exported or public entities.

Suggested labels

PR: Fix

Suggested reviewers

• OH296
• EttyKitty

---

🪧 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: 1

🔭 Outside diff range comments (1)

scripts/scr_add_artifact/scr_add_artifact.gml (1)

341-421: 💡 Verification agent

🧩 Analysis chain

Verification of the sanctified solution is required by the Machine Spirit.

The Omnissiah's wisdom compels me to confirm that all equipment update pathways have been modified consistently. Let us run a cogitation ritual to ensure no equipment update call remains that could trigger the unholy recursion.

---

🏁 Script executed:

#!/bin/bash
# By the will of the Omnissiah, this script searches for any update functions still using 'false' as the third parameter

echo "Initiating binary divination to locate any remaining recursion points..."

# Check for any update_*("", false, false) patterns that might still exist
rg "update_(weapon_one|weapon_two|armour|gear|mobility_item)\(\"\",[^,]+,\s*false\)" scripts/

echo "Checking for any other functions that might call delete_artifact..."
rg "delete_artifact\(" --type gml --exclude "scr_add_artifact/scr_add_artifact.gml"

echo "Binary divination complete."

Length of output: 1412

---

Directive: Reconcile Inconsistent Update Function Parameters Across Artifact Scripts

Hail, servant of the Machine Spirit! The script in scripts/scr_add_artifact/scr_add_artifact.gml now invokes the update functions with the proper third argument (true), as per the sacred directives. However, our binary divination has revealed that the adjutant file scripts/scr_check_equip/scr_check_equip.gml still invokes the update methods—such as update_weapon_one, update_weapon_two, update_armour, update_mobility_item, and update_gear—with the third parameter set to false. This discrepancy may yet birth unwanted recursive anomalies and disrupt the Omnissiah's vision.

Action Points:

• Review & Revise: Examine scripts/scr_check_equip/scr_check_equip.gml and update any calls to update functions so that the third parameter uniformly declares true, as sanctified.
• Consistency Check: Ensure that all equipment update pathways across your artifact scripts adhere to this new parameter set, thereby achieving the harmonious state decreed by the Machine Spirit.

Let no errant value persist; correct these deviations, and the blessings of the Omnissiah shall be bestowed upon your work.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 57230a1 and 90c3ee1.

📒 Files selected for processing (2)

• scripts/scr_add_artifact/scr_add_artifact.gml (3 hunks)
• scripts/scr_unit_equip_functions/scr_unit_equip_functions.gml (2 hunks)

🔇 Additional comments (3)

scripts/scr_unit_equip_functions/scr_unit_equip_functions.gml (1)

80-80: Binary blessing: Enlightening comment reveals the Machine Spirit's feedback loop.

The Omnissiah guides thy hand in documenting this logic loop. This illuminating comment rightfully identifies the source of the recursive feedback pattern where delete_artifact calls unequip_from_unit, which invokes the equipment update functions, potentially causing an endless logic loop.

scripts/scr_add_artifact/scr_add_artifact.gml (2)

371-375: Binary perfection: Consistent parameter rectification for weapon processing.

The holy cogitators approve of this logical correction. By making these consistent adjustments to the to_armoury parameter in the weapons processing section of the unequipping routine, you have ensured that when artifacts are discovered on units through iteration, they too follow the sacred path of proper unequipping mechanics rather than invoking the recursive deletion path.

---

402-402: Mechanicus approval: Final parameter correction completes the sacred circuit.

This adjustment in the dynamic function invocation pathway completes the circuit of logical corrections. The third parameter is now consistently set to true across all equipment types, ensuring that the unit's equipment update functions do not trigger artifact deletion, thus preventing the nefarious feedback loop from consuming precious computational cycles.