more cleanups and header update

Author: mcmonkey4eva

scripts/dmodels_loader.dsc

@@ -41,7 +41,7 @@ dmodels_load_bbmodel:
         - stop
     # =============== Pack validation ===============
     - if !<server.has_flag[data/dmodels/res_pack/pack.mcmeta]>:
-        - filewrite path:data/dmodels/res_pack/pack.mcmeta data:<map.with[pack].as[<map[pack_format=8;description=dModels_AutoPack_Default]>].to_json[native_types=true;indent=4].utf8_encode>
+        - run dmodels_multiwaitable_filewrite def.key:<[model_name]> def.path:data/dmodels/res_pack/pack.mcmeta def.data:<map.with[pack].as[<map[pack_format=8;description=dModels_AutoPack_Default]>].to_json[native_types=true;indent=4].utf8_encode>
     # =============== Textures loading ===============
     - define tex_id 0
     - foreach <[data.textures]||<list>> as:texture:
@@ -53,7 +53,7 @@ dmodels_load_bbmodel:
             - debug error "[DModels] Can't load bbmodel for '<[model_name]>': invalid texture source data."
             - stop
         - define texture_output_path <[textures_root]>/<[texname]>.png
-        - ~filewrite path:<[texture_output_path]> data:<[raw_source].after[,].base64_to_binary>
+        - run dmodels_multiwaitable_filewrite def.key:<[model_name]> def.path:<[texture_output_path]> def.data:<[raw_source].after[,].base64_to_binary>
         - define proper_path dmodels/<[model_name]>/<[texname]>
         - define mc_texture_data.<[tex_id]> <[proper_path]>
         - if <[texture.particle]||false>:
@@ -105,7 +105,7 @@ dmodels_load_bbmodel:
                     - else:
                         - define anim_map.data <[data_points.x]>,<[data_points.y]>,<[data_points.z]>
                     - define animation_list.<[animation.name]>.animators.<[o_uuid]>.frames:->:<[anim_map]>
-                # Time sort
+                # Sort frames by time (why is this not done by default? BlockBench is weird)
                 - define animation_list.<[animation.name]>.animators.<[o_uuid]>.frames <[animation_list.<[animation.name]>.animators.<[o_uuid]>.frames].sort_by_value[get[time]]>
     - flag server dmodels_data.animations_<[model_name]>:<[animation_list]>
     # =============== Item model file generation ===============
@@ -149,7 +149,7 @@ dmodels_load_bbmodel:
             - define model_json.display.head.translation <list[32|25|32]>
             - define model_json.display.head.scale <list[4|4|4]>
             - define modelpath item/dmodels/<[model_name]>/<[outline.name]>
-            - ~filewrite path:<[models_root]>/<[outline.name]>.json data:<[model_json].to_json[native_types=true;indent=4].utf8_encode>
+            - run dmodels_multiwaitable_filewrite def.key:<[model_name]> def.path:<[models_root]>/<[outline.name]>.json def.data:<[model_json].to_json[native_types=true;indent=4].utf8_encode>
             - define cmd 0
             - define min_cmd 1000
             - foreach <[override_item_data.overrides]||<list>> as:override:
@@ -164,10 +164,21 @@ dmodels_load_bbmodel:
         # This sets the actual live usage flag data
         - flag server dmodels_data.model_<[model_name]>.<[outline.uuid]>:<[outline]>
     - if <[overrides_changed]>:
-        - ~filewrite path:<[override_item_filepath]> data:<[override_item_data].to_json[native_types=true;indent=4].utf8_encode>
+        - run dmodels_multiwaitable_filewrite def.key:<[model_name]> def.path:<[override_item_filepath]> def.data:<[override_item_data].to_json[native_types=true;indent=4].utf8_encode>
+    # Ensure all filewrites are done before ending the task
+    - waituntil rate:1t max:5m <server.flag[dmodels_data.temp_<[model_name]>.filewrites].is_empty||true>
     # Final clear of temp data
     - flag server dmodels_data.temp_<[model_name]>:!
 
+dmodels_multiwaitable_filewrite:
+    type: task
+    debug: false
+    definitions: key|path|data
+    script:
+    - flag server dmodels_data.temp_<[key]>.filewrites.<[path].escaped>
+    - ~filewrite path:<[path]> data:<[data]>
+    - flag server dmodels_data.temp_<[key]>.filewrites.<[path].escaped>:!
+
 dmodels_facefix:
     type: procedure
     debug: false

scripts/dmodels_main.dsc

@@ -7,11 +7,11 @@
 #
 # @author mcmonkey
 # @date 2022/06/01
-# @updated 2022/06/13
+# @updated 2022/07/06
 # @denizen-build REL-1772
-# @script-version 1.3
+# @script-version 1.4
 #
-# This takes BlockBench "BBModel" files, converts them (via external program) to resource pack + Denizen-compatible file,
+# This takes BlockBench "BBModel" files, converts them to a client-ready resource pack and Denizen internal data,
 # then is able to display them in minecraft and even animate them, by spawning and moving invisible armor stands with resource pack items on their heads.
 #
 # Installation:
@@ -96,6 +96,15 @@
 #                 animation: The name of the animation to play (as set in BlockBench).
 #                 timespot: The time (in seconds) from the start of the animation to select as the frame.
 #                 delay_pose: 'true' if playing fluidly to offset the pose application over time, 'false' to snap exactly to frame position.
+#     Flags:
+#         Every entity spawned by DModels has the flag 'dmodel_root', that refers up to the root entity.
+#         The root entity has the following flags:
+#             'dmodel_model_id': the name of the model used.
+#             'dmodel_parts': a list of all part entities spawned.
+#             'dmodel_anim_part.<ID_HERE>': a mapping of outline IDs to the part entity spawned for them.
+#             'dmodels_animation_id': only if the model is animating automatically, contains the animation ID.
+#             'dmodels_anim_time': only if the model is animating automatically, contains the progress through the current animation as a number representing time.
+#        Additional flags are present on both the root and on parts, but are not considered API - use at your own risk.
 #
 ################################################
 

scripts/dmodels_spawning.dsc

@@ -26,7 +26,9 @@ dmodels_spawn_model:
     - define center <[location].with_pitch[0].below[0.72]>
     - define yaw_mod <[location].yaw.add[180].to_radians>
     - spawn dmodel_part_stand <[location]> save:root
-    - flag <entry[root].spawned_entity> dmodel_model_id:<[model_name]>
+    - define root <entry[root].spawned_entity>
+    - flag <[root]> dmodel_model_id:<[model_name]>
+    - flag <[root]> dmodel_root:<[root]>
     - define parentage <map>
     - define model_data <server.flag[dmodels_data.model_<[model_name]>]>
     - define tracking_range <[tracking_range].if_null[<script[dmodels_config].data_key[tracking_range]>]>
@@ -52,10 +54,10 @@ dmodels_spawn_model:
             - adjust <entry[spawned].spawned_entity> tracking_range:<[tracking_range]>
         - flag <entry[spawned].spawned_entity> dmodel_def_pose:<[new_rot].xyz>
         - flag <entry[spawned].spawned_entity> dmodel_def_offset:<[new_pos].div[16]>
-        - flag <entry[spawned].spawned_entity> dmodel_root:<entry[root].spawned_entity>
-        - flag <entry[root].spawned_entity> dmodel_parts:->:<entry[spawned].spawned_entity>
-        - flag <entry[root].spawned_entity> dmodel_anim_part.<[id]>:->:<entry[spawned].spawned_entity>
-    - determine <entry[root].spawned_entity>
+        - flag <entry[spawned].spawned_entity> dmodel_root:<[root]>
+        - flag <[root]> dmodel_parts:->:<entry[spawned].spawned_entity>
+        - flag <[root]> dmodel_anim_part.<[id]>:->:<entry[spawned].spawned_entity>
+    - determine <[root]>
 
 dmodels_delete:
     type: task