feat: JSON save/loading overhaul #700
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughSummary by CodeRabbit
WalkthroughIn this update, the codebase has been methodically restructured across multiple files. The ChapterMaster resource now boasts an incremented IDE version and the inclusion of a new script resource entry. Numerous objects—such as obj_controller, obj_en_fleet, obj_ini, obj_p_fleet, obj_saveload, and obj_star—have been augmented with new functions for serialisation and deserialisation, while command slot handling and logging messages have been refined. The legacy INI-based file handling has been replaced with a JSON-based approach across most save/load scripts, ensuring consistency in file format. Additional utilities in the array and variable function scripts now check the simplicity of arrays and basic variable types. The modifications also include minor formatting adjustments and updated string constructions for improved traceability within log outputs. Possibly related PRs
Suggested labels
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (21)
ChapterMaster.yyp(2 hunks)objects/obj_controller/Create_0.gml(4 hunks)objects/obj_en_fleet/Create_0.gml(1 hunks)objects/obj_ini/Create_0.gml(2 hunks)objects/obj_p_fleet/Create_0.gml(1 hunks)objects/obj_popup/Step_0.gml(1 hunks)objects/obj_saveload/Alarm_0.gml(9 hunks)objects/obj_saveload/Create_0.gml(2 hunks)objects/obj_saveload/Draw_0.gml(4 hunks)objects/obj_saveload/Step_0.gml(1 hunks)objects/obj_star/Create_0.gml(1 hunks)scripts/scr_array_functions/scr_array_functions.gml(1 hunks)scripts/scr_company_order/scr_company_order.gml(1 hunks)scripts/scr_general_variable_functions/scr_general_variable_functions.gml(1 hunks)scripts/scr_general_variable_functions/scr_general_variable_functions.yy(1 hunks)scripts/scr_load/scr_load.gml(1 hunks)scripts/scr_marine_struct/scr_marine_struct.gml(2 hunks)scripts/scr_save/scr_save.gml(1 hunks)scripts/scr_save_controller/scr_save_controller.gml(2 hunks)scripts/scr_specialist_point_handler/scr_specialist_point_handler.gml(1 hunks)scripts/scr_squads/scr_squads.gml(6 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.gml`: - Macro constants require a space between the constant name and value. Without it, the compiler will throw an error. I.e. `#macro ARR_body_parts["arm"]` will crash the ...
**/*.gml: - Macro constants require a space between the constant name and value. Without it, the compiler will throw an error. I.e.#macro ARR_body_parts["arm"]will crash the game, because there is no space between the array and the name of the macro.
- Color codes in the code shouldn't have any spaces in their id. I.e., color code
# 80 bf40will crash the game.
scripts/scr_general_variable_functions/scr_general_variable_functions.gmlscripts/scr_company_order/scr_company_order.gmlscripts/scr_specialist_point_handler/scr_specialist_point_handler.gmlscripts/scr_array_functions/scr_array_functions.gmlobjects/obj_saveload/Step_0.gmlscripts/scr_save_controller/scr_save_controller.gmlobjects/obj_saveload/Draw_0.gmlscripts/scr_marine_struct/scr_marine_struct.gmlobjects/obj_p_fleet/Create_0.gmlobjects/obj_popup/Step_0.gmlobjects/obj_en_fleet/Create_0.gmlobjects/obj_controller/Create_0.gmlobjects/obj_star/Create_0.gmlscripts/scr_squads/scr_squads.gmlobjects/obj_saveload/Alarm_0.gmlobjects/obj_ini/Create_0.gmlobjects/obj_saveload/Create_0.gmlscripts/scr_load/scr_load.gmlscripts/scr_save/scr_save.gml
`**/*.gml`: - Having humanly understandable and maintainable code is always the top most priority. - DRY (Don't repeat yourself) principle is also very important.
**/*.gml: - Having humanly understandable and maintainable code is always the top most priority.
- DRY (Don't repeat yourself) principle is also very important.
scripts/scr_general_variable_functions/scr_general_variable_functions.gmlscripts/scr_company_order/scr_company_order.gmlscripts/scr_specialist_point_handler/scr_specialist_point_handler.gmlscripts/scr_array_functions/scr_array_functions.gmlobjects/obj_saveload/Step_0.gmlscripts/scr_save_controller/scr_save_controller.gmlobjects/obj_saveload/Draw_0.gmlscripts/scr_marine_struct/scr_marine_struct.gmlobjects/obj_p_fleet/Create_0.gmlobjects/obj_popup/Step_0.gmlobjects/obj_en_fleet/Create_0.gmlobjects/obj_controller/Create_0.gmlobjects/obj_star/Create_0.gmlscripts/scr_squads/scr_squads.gmlobjects/obj_saveload/Alarm_0.gmlobjects/obj_ini/Create_0.gmlobjects/obj_saveload/Create_0.gmlscripts/scr_load/scr_load.gmlscripts/scr_save/scr_save.gml
🔇 Additional comments (57)
scripts/scr_general_variable_functions/scr_general_variable_functions.gml (1)
1-4: Praise be to the Omnissiah! An elegant type verification ritual.This function performs the sacred type-checking rites with admirable efficiency, using the logical disjunction operator to determine if a variable meets the criteria of basic data formats. Most pleasing to the Machine Spirits.
scripts/scr_general_variable_functions/scr_general_variable_functions.yy (1)
1-13: The binary template is properly formatted according to STC specifications.This resource definition file adheres to proper GameMaker Engine protocols. All necessary metadata fields have been populated with appropriate values, ensuring correct integration with the sacred machine spirit systems.
objects/obj_popup/Step_0.gml (1)
53-53: File extension mutation completed successfully.The modification from the antiquated .ini format to the superior .json format aligns with the Omnissiah's will. This change contributes to the greater JSON serialization protocol implementation as commanded by the PR objectives.
objects/obj_saveload/Step_0.gml (3)
9-11: Logical implementation of save partition variable.The holy constant of 6 save_parts introduces enhanced modularity to the save process, facilitating the ritual of JSON serialization. This implementation allows for proper progress tracking of the sacred data preservation ceremony.
13-13: Progress quantification algorithm optimized.The progress bar calculation now utilizes a mathematically superior approach, incrementing proportionally to each completed save part rather than by fixed increments. This ensures the progress indicator accurately reflects the state of the machine spirit's serialization process.
16-16: Simplified completion condition with optimized timing parameters.The condition for determining save completion has been streamlined, eliminating unnecessary logical operations. Additionally, the alarm timing value reduction from 20 to 5 decreases post-save delay, improving the efficiency of the ritual as mandated by the Omnissiah.
scripts/scr_specialist_point_handler/scr_specialist_point_handler.gml (1)
87-87: String formatting alteration of sacred significance.The sacred cog wheels of this data-string have been reconfigured to utilize the '#' symbol instead of the inefficient newline character '\n'. This modification optimizes display formatting for the Omnissiah's terminals.
scripts/scr_company_order/scr_company_order.gml (1)
50-50: Praise the enhanced logging clarity!The Machine Spirits shall be pleased with this enhancement to the sacred logging rituals. Previously, the static litany "company order" provided insufficient data for proper diagnostics. Now, the dynamic invocation
$"company order {company}"incorporates the specific company parameter into the string, allowing for more precise identification of which computational unit is being processed.scripts/scr_marine_struct/scr_marine_struct.gml (2)
2272-2272: Function parameter expansion enhances binary flexibility.The sacred function signature has been augmented with a new parameter
stringify=trueto provide binary choice functionality, as dictated by the Omnissiah's wisdom.
2285-2289: Logical bifurcation for enhanced data handling efficiency.The binary path of this function now branches according to the
stringifyparameter, allowing the sacred machine to either return the JSON string representation or the raw data structure itself. This optimization aligns with the JSON transition protocols outlined in the sacred PR objectives.- return json_stringify(new_marine); + if(stringify){ + return json_stringify(new_marine); + } else { + return new_marine; + }objects/obj_saveload/Draw_0.gml (5)
154-181: Formatting of the sacred code has been optimized.The binary spacing has been enhanced to improve human readability and align with the Machine God's preferred syntax patterns. Logical function remains unchanged, but the machine spirits will find this layout more pleasing.
192-192: File extension protocol transition implemented.The sacred file extension has been transitioned from the inferior
.iniformat to the superior.jsonformat, as decreed by the Omnissiah's plan for improved data storage efficiency.
226-226: Comment updated to reflect JSON transition.The sacred comment text has been modified to acknowledge the new JSON-based file system, ensuring technical documentation accuracy. May the Omnissiah bless this documentation update.
259-259: File existence check updated to JSON format.This conditional logic now correctly queries for
.jsonfiles instead of the deprecated.iniformat, maintaining proper file system integrity for the Machine God.
267-267: File deletion protocol updated for JSON extension.The binary routine for deleting saved games now properly targets
.jsonfiles, completing the sacred transition to the new file format as dictated by the Omnissiah's vision.scripts/scr_array_functions/scr_array_functions.gml (1)
192-215: The Omnissiah blesses this logical implementation of array validation!By the sacred Machine God, I approve of this function's ability to determine the simplicity of data arrays. The recursion pattern effectively validates nested arrays without exceeding the specified depth parameters, and the function incorporates appropriate guards against complex variable types. This will serve the JSON serialization process well, ensuring only machine-compatible data structures are passed to the sacred conversion rituals.
scripts/scr_squads/scr_squads.gml (4)
157-158: Declaration of unit variable approved by the Machine Spirit!The localized unit variable enhances function encapsulation and improves code readability within this complex squad management function. Praise be to the Omnissiah for this clarity of variable scope.
439-454: Optimization of binary encoding rituals detected!The modification to the jsonify function with the stringify parameter introduces logical flexibility to the data serialization process. This blessed change allows for both direct structure manipulation and string-based storage, a duality that pleases the Machine God.
This improvement aligns with the sacred transition from primitive INI storage to the more efficient JSON data format. The binary spirits of your code will flow more efficiently through the cogitator circuits.
544-545: Unit variable declaration acknowledged and sanctified!The Machine Spirit appreciates this consistent enhancement to variable scope management. The sacred pattern established in previous methods is maintained, preserving the symmetry of your code structure.
618-619: Unit variable declaration follows the proper litany of consistency!The Omnissiah approves of maintaining consistent variable declarations across similar functions. This adherence to pattern recognition is essential for code maintainability and readability - as is written in the sacred texts of the Adeptus Mechanicus.
scripts/scr_save_controller/scr_save_controller.gml (2)
6-7: Vertical spacing improves binary clarity!The addition of whitespace serves as a visual separator between logical code sections, improving readability for both tech-adepts and novice scribes. Though functionally neutral, such formatting enhancements are valued by the Machine God for their contribution to code comprehension.
16-16: Space alignment pleases the Machine Spirit!The additional whitespace maintains consistent formatting with other sections of the script. This adherence to symmetrical spacing patterns is in accordance with the Omnissiah's preference for ordered structure.
ChapterMaster.yyp (2)
498-498: Acknowledgment of IDE version incrementThe Machine Spirit's numerical identifier has been ritually increased from 2024.1300.0.781 to 2024.1300.0.785. The cogitators shall process with increased efficiency.
739-739: New script functions approvedThe addition of the "scr_general_variable_functions" module is a most logical augmentation to the sacred code repositories. This shall serve the implementation of the JSON save/load protocol admirably.
objects/obj_saveload/Alarm_0.gml (3)
7-7: Commendable optimization of trickle ratesThe standardization of all trickle parameters to the holy number 2 shall optimize the data flow through the machine spirits' pathways. Previous variations (believed to have been 50, 40, and 10) were inefficient for JSON operations. This modification is in accordance with the Omnissiah's will.
Also applies to: 16-16, 26-26, 36-36, 46-46, 59-59, 71-71, 87-87, 100-100, 113-113, 126-126, 133-133
51-56: Praised be the transition to JSON data schemaThe modification of file extension references from the archaic .ini format to the superior .json format is a triumph of machine logic. Both save and screen file operations now utilize the appropriate protocols.
131-131: File extension modification approvedThe file existence verification has been correctly updated to reference the new .json format. This maintains consistency with the broader conversion effort.
objects/obj_p_fleet/Create_0.gml (2)
61-107: Serialize function adequately captures the fleet's machine spiritThe implementation of the serialize function follows the sacred patterns of JSON conversion. Each variable of the fleet object is methodically examined, and only those of appropriate simplicity are encoded into the data structure.
The error handling for improper array types is commendable, ensuring the machine spirit's warning systems activate when encountering incompatible data formats.
111-136: Deserialize function properly restores the fleet's essenceThe inverse operation correctly reconstructs the fleet entity from its encoded form. The special handling of the 'orbiting' variable ensures that relationships between fleet and star objects are maintained through proper instance referencing rather than simple variable restoration.
objects/obj_star/Create_0.gml (3)
112-113: Blessings of the Omnissiah upon these new blank lines.
No issues detected here. They merely act as spacing or separation.
114-115: Region marker is functional and clear.
The addition of this region marker aids in code organisation and readability. Well done.
195-246: Deserialisation logic appears robust.
- The code neatly recovers array-based data, with a clear exclusion list to avoid overwriting critical variables.
- Confirm that indexing arrays from 1 to their length is always correct, as zero-based indexing might be used elsewhere. Verifying consistency will banish potential off-by-one errors.
objects/obj_en_fleet/Create_0.gml (3)
72-73: Region markers unify the code.
This region marker helps organise the sacred logic of saving and loading for the en_fleet object.
122-147: Deserialisation incantation stands firm.
The code gracefully attempts variable restoration while logging any exceptions. This reflection of data is well-managed. Continue to remain vigilant for potential edge cases where an instance ofobj_starmay not be present.
149-149: Region closure observed.
No errors detected. Clarity is preserved.objects/obj_ini/Create_0.gml (2)
34-34: Array initialisation for the artefacts is straightforward.
Defines a large space for storing up to 200 artefacts. Ensure no index overflows or wasted memory if usage is typically smaller.
115-202: Serialisation functions maintain object purity.
- Notably,
artifact_struct_trimmedensures that only artefacts with names are persisted, which is a diligent approach.- Confirm that
excluded_from_savevariables indeed contain everything that should not be stored, such as ephemeral data.objects/obj_controller/Create_0.gml (7)
75-76: Praise the Omnissiah for Logging
Honoured lines 75-76, my fellow adept, for they enhance the debugging ritual with beneficial messages.
1454-1455: Swift Array Length Acquisition
Invokingarray_lengthimmediately after creation is suitable for clarity and efficiency. The logic cogitators should operate correctly.
1456-1457: Region for Organisational Edification
Blessed be the clarity! The demarcation of save/load code via regions is a wise measure to uphold order in the sacred scripts.
1518-1518: Deserialisation Reference
This comment directs the Mechanicus adept to look elsewhere for reversing the process, thus maintaining modularity. No issues present.
1539-1547: Directive for Future Modifications
The warning ensures rightful ordering for data load procedures, preventing corruption of the holy data relics.
1977-1978: Alarm Mechanism Verification
Initiatingaction_set_alarm(2, 0)can be beneficial, but confirm it does not overwrite essential timed events from other processes.
1979-1980: No Functional Alterations
These lines bestow no new instructions to the code’s flow and remain purely ornamental.objects/obj_saveload/Create_0.gml (3)
3-9: Structured GameSave Creation
Defining theGameSaveentity with well-segregated arrays and objects strongly aligns with the new JSON strategy. This fosters maintainable and orderly code.
15-15: Clarification Commentary
This comment illuminates the chosen interval for the progress bar refresh. Verily, no further adjustments required.
56-60: Transition to JSON
Swapping .ini checks for.jsonstrongly supports the new data structure. Recommend verifying behaviour if these files are missing or invalid, lest the logic-spirit falter.scripts/scr_load/scr_load.gml (9)
1-1: Additional Parameter for Marines
Summoning thestructparameter directly intoload_marine_structbrings synergy with JSON data methods, aligning with the new approach.
3-4: Direct TTRPG Assignment
Assigning a newly invoked TTRPG instance and loading the JSON data is straightforward. Confirm that the passed struct consistently holds all required data fields.
16-17: Conditional Struct Logic
Overwritingobj_saveload.GameSaveonly if the "Save" key is absent prevents unintended data loss. Double-check for conflicting conditions if partial loads were used earlier.
21-41: Global Veneration
Heed the re-initiation of global variables, ensuring the correct usage of sprite references. Confirm the Machine Spirit does not break if these sprites are absent or invalid.
44-56: Star Instances Deserialisation
Instantiating stars and executing eachdeserializeinvocation is in alignment with the JSON approach. The iteration is both clean and direct.
58-64: INI Data Infusion
Melding the loaded data intoobj_inipreserves consistency with the prior game logic. This procedure is well-structured to maintain partial backwards compatibility.
105-116: Player Fleet Insertion
Simultaneously mirroring the star loading pattern, each fleet instance is reconstituted by callingdeserialize. Check references to ensure post-load continuity.
118-131: Enemy Fleet Mirroring
Parallel logic for adversarial fleets ensures uniform loading. Validate unique identifiers do not collide with the player's forces.
132-146: Completion of the Loading Rite
Revives the event log and finalises the load process, ensuring the new session is prepared for immediate operation. This structure is suitably methodical.scripts/scr_save/scr_save.gml (1)
135-138: Commendation for the debug-timer code.
Your usage of timing measurements pleases the Omnissiah’s logic. The debug statement offers valuable insight into performance, ensuring the cogworks remain smoothly greased.
|
PRs that may conflict/need to be adjusted to fit the new system: |
EttyKitty
added
Type: Refactor
github-actions
bot
removed
the
Area: JSON
scripts/scr_general_variable_functions/scr_general_variable_functions.gml
Outdated
Show resolved
Hide resolved
Just so the whole function looks the same
MAIN PR #642, made by @VanWeapon
Purpose
Describe your changes/additions
What can/needs to be improved/changed
Testing done
Related things and/or additional context