auto_animate for attached

Author: mcmonkey4eva

scripts/dmodels_animating.dsc

@@ -171,7 +171,7 @@ dmodels_catmullrom_proc:
 dmodels_attach_to:
     type: task
     debug: false
-    definitions: root_entity|target
+    definitions: root_entity|target|auto_animate
     script:
     - if !<[root_entity].is_truthy> || !<[root_entity].has_flag[dmodel_model_id]||false>:
         - debug error "[DModels] invalid attach_to root_entity <[root_entity]>"
@@ -180,6 +180,7 @@ dmodels_attach_to:
         - debug error "[DModels] invalid attach_to target <[target]>"
         - stop
     - flag <[root_entity]> dmodels_attached_to:<[target]>
+    - flag <[root_entity]> dmodels_attach_auto_animate:<[auto_animate]||false>
     - flag server dmodels_attached.<[root_entity].uuid>:<[root_entity]>
 
 dmodels_animator_world:
@@ -189,7 +190,20 @@ dmodels_animator_world:
         on tick server_flagged:dmodels_attached priority:-20:
         - foreach <server.flag[dmodels_attached]> as:root:
             - if <[root].is_spawned||false> && <[root].flag[dmodels_attached_to].is_spawned||false>:
-                - teleport <[root]> <[root].flag[dmodels_attached_to].location>
+                - define target <[root].flag[dmodels_attached_to]>
+                - teleport <[root]> <[target].location>
+                - if <[root].flag[dmodels_attach_auto_animate]> && !<[root].flag[dmodels_temp_alt_anim].is_truthy||false>:
+                    - define preferred idle
+                    - if <[target].is_sneaking||false>:
+                        - define preferred crouching_idle
+                    - if <[target].velocity.vector_length> > 0.1:
+                        - define preferred running
+                        - if <[target].velocity.vector_length> > 1.2:
+                            - define preferred sprinting
+                        - if <[target].velocity.y> > 0.1:
+                            - define preferred jump
+                    - if <[root].flag[dmodels_animation_id]||none> != <[preferred]> && <server.has_flag[dmodels_data.animations_<[root].flag[dmodel_model_id]>.<[preferred]>]||null>:
+                        - run dmodels_animate def.root_entity:<[root]> def.animation:<[preferred]>
                 - if !<[root].has_flag[dmodels_animation_id]>:
                     - run dmodels_reset_model_position def.root_entity:<[root]>
         on tick server_flagged:dmodels_anim_active priority:-10:

scripts/dmodels_citizens.dsc

@@ -32,7 +32,7 @@ dmodels_npc_spawn:
         - stop
     - adjust <npc> hide_from_players
     - flag <npc> dmodels_root:<[root]>
-    - run dmodels_attach_to def.root_entity:<[root]> def.target:<npc>
+    - run dmodels_attach_to def.root_entity:<[root]> def.target:<npc> def.auto_animate:true
 
 dmodels_npc_despawn:
     type: task

scripts/dmodels_main.dsc

@@ -19,6 +19,7 @@
 # Installation:
 # 1: Edit your "plugins/Denizen/config.yml", find "File:", and "Allow read" and "Allow write" inside, and set them both to "true", then use "/denizen reload config"
 # 2: Copy the "scripts/dmodels" folder to your "plugins/Denizen/scripts" and "/ex reload"
+# 2.5: NOTE: If you do not use the plugin Citizens, you can exclude the "dmodels_citizens" file.
 # 3: Note that you must know the basics of operating resource packs - the pack content will be generated for you, but you must know how to install a pack on your client and/or distribute it to players as appropriate
 # 4: Take a look at the config settings in the bottom of this file in case you want to change any of them.
 #
@@ -123,6 +124,7 @@
 #             Input definitions:
 #                 root_entity: The root entity gotten from 'dmodels_spawn_model'.
 #                 target: The entity to be attached to.
+#                 auto_animate: (OPTIONAL) set to 'true' to indicate the model should automatically apply animations based on the entity it's attached to. See 'core animations' list below.
 #     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:
@@ -131,8 +133,22 @@
 #             '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.
+#             'dmodels_attached_to': the entity this model is attached to, if any.
+#             'dmodels_temp_alt_anim': if set to a truthy value, will tell the model to not play any auto-animations (so other scripts can indicate they need to override the default)
 #        Additional flags are present on both the root and on parts, but are not considered API - use at your own risk.
 #
+# #########
+#
+# Core Animations:
+# Some systems within DModels look for certain core animations to exist, and will use them when relevant.
+# For example, the with the 'dmodels_attach_to' task, with the 'auto_animate' flag enabled (or the 'npcmodel' command which enables it by default), will apply animations to match the attached entity.
+# List:
+#     'idle': default/no activity idle animation.
+#     'crouching_idle': default/no activity idle animation, while crouching (sneaking).
+#     'running': the animation for moving at normal speed.
+#     'sprinting': the animation for moving very fast.
+#     'jump': the animation for jumping in place.
+#
 ################################################
 
 dmodels_config: