Add emissive layer handling for hidden entities

- Added proper handling of hidden entities with emissive layers (Endermen, Spiders, Cave Spiders) by shrinking their scale and tracking their position to prevent enclosure breaches (closes #25)
- Modified the attack predicate of the secondary dig-up requirements so that it disregards the Y-distance. This allows mobs to, for example, appear at the bottom of pillars, if a player decides to build up during the night
- Added an activation distance recommendation message when using the vanilla activation mode
- Fixed possibility for hidden falling mobs to lose their fall distance NBT when appearing
- Updated CD workflow output formatting

Author: Tschipcraft

.github/workflows/cd.yml

@@ -358,42 +358,43 @@ jobs:
         run: |
           echo "Building summary..."
           if [ "${{ job.status }}" == "success" ]; then
-            SUMMARY_CONTENT="<picture>
-              <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/light-theme/success.svg\">
-              <img alt=\"✅ Success\" src=\"https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/dark-theme/success.svg\">
-            </picture><br>
+          SUMMARY_CONTENT="<picture>
+            <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/light-theme/success.svg\">
+            <img alt=\"✅ Success\" src=\"https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/dark-theme/success.svg\">
+          </picture><br>
 
-            **${{ github.event.repository.name }} v${{ github.event.inputs.tag }}** for **Minecraft ${{ env.MC_HUMAN_VERSION_RANGE }}** published successfully!
+          **${{ github.event.repository.name }} v${{ github.event.inputs.tag }}** for **Minecraft ${{ env.MC_HUMAN_VERSION_RANGE }}** published successfully!
 
-            [View Changelog](https://github.com/${{ github.repository }}/blob/v${{ github.event.inputs.tag }}/CHANGES.md)
+          [View Changelog](https://github.com/${{ github.repository }}/blob/v${{ github.event.inputs.tag }}/CHANGES.md)
 
-            **Downloads:**
-            "
+          **Downloads:**
+          "
 
-            if [ -n "${{ steps.upload_modrinth_dp.outputs.modrinth-url }}" ]; then
-              SUMMARY_CONTENT+="- [Modrinth (Data Pack)](${{ steps.upload_modrinth_dp.outputs.modrinth-url }})
-              "
-            fi
-            if [ -n "${{ steps.upload_modrinth_mod.outputs.modrinth-url }}" ]; then
-              SUMMARY_CONTENT+="- [Modrinth (Mod)](${{ steps.upload_modrinth_mod.outputs.modrinth-url }})
-              "
-            fi
-            if [ -n "${{ steps.upload_curseforge_dp.outputs.curseforge-url }}" ]; then
-              SUMMARY_CONTENT+="- [CurseForge (Data Pack)](${{ steps.upload_curseforge_dp.outputs.curseforge-url }})
-              "
-            fi
-            if [ -n "${{ steps.upload_curseforge_mod.outputs.curseforge-url }}" ]; then
-              SUMMARY_CONTENT+="- [CurseForge (Mod)](${{ steps.upload_curseforge_mod.outputs.curseforge-url }})
-              "
-            fi
-            if [ -n "${{ steps.upload_github.outputs.github-url }}" ]; then
-              SUMMARY_CONTENT+="- [GitHub Releases](${{ steps.upload_github.outputs.github-url }})
-              "
-            fi
+          if [ -n "${{ steps.upload_modrinth_dp.outputs.modrinth-url }}" ]; then
+            SUMMARY_CONTENT+="- [Modrinth (Data Pack)](${{ steps.upload_modrinth_dp.outputs.modrinth-url }})
+          "
+          fi
+          if [ -n "${{ steps.upload_modrinth_mod.outputs.modrinth-url }}" ]; then
+            SUMMARY_CONTENT+="- [Modrinth (Mod)](${{ steps.upload_modrinth_mod.outputs.modrinth-url }})
+          "
+          fi
+          if [ -n "${{ steps.upload_curseforge_dp.outputs.curseforge-url }}" ]; then
+            SUMMARY_CONTENT+="- [CurseForge (Data Pack)](${{ steps.upload_curseforge_dp.outputs.curseforge-url }})
+          "
+          fi
+          if [ -n "${{ steps.upload_curseforge_mod.outputs.curseforge-url }}" ]; then
+            SUMMARY_CONTENT+="- [CurseForge (Mod)](${{ steps.upload_curseforge_mod.outputs.curseforge-url }})
+          "
+          fi
+          if [ -n "${{ steps.upload_github.outputs.github-url }}" ]; then
+            SUMMARY_CONTENT+="- [GitHub Releases](${{ steps.upload_github.outputs.github-url }})
+          "
+          fi
+
+          echo -e "$SUMMARY_CONTENT" >> $GITHUB_STEP_SUMMARY
 
-            echo -e "$SUMMARY_CONTENT" >> $GITHUB_STEP_SUMMARY
           else
-            cat << EOF >> $GITHUB_STEP_SUMMARY
+          cat << EOF >> $GITHUB_STEP_SUMMARY
           <picture>
             <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/light-theme/error.svg">
             <img alt="❌ Error" src="https://raw.githubusercontent.com/Mqxx/GitHub-Markdown/main/blockquotes/badge/dark-theme/error.svg">

CHANGES.md

@@ -1,3 +1,7 @@
-- Improved performance by refactoring entity activation distance calculations to bundle and cache position data retrieval calls, and updating batch activation logic (up to 1 ms faster per tick!)
+- **Entities with emissive layers are now properly hidden** (Endermen, Spiders, and Cave Spiders) (closes [#25](https://github.com/Tschipcraft/spawnanimations/issues/25))
+- Improved performance by refactoring entity activation distance calculations to bundle and cache position data retrieval calls, and updating batch activation logic (the whole data pack is now up to 1ms (~45%ish) faster per tick!)
+- Modified the attack predicate of the secondary dig-up requirements so that it disregards the Y-distance. This allows mobs to, for example, appear at the bottom of pillars, if a player decides to build up during the night
+- Added an activation distance recommendation message when using the vanilla activation mode
+- Fixed possibility for hidden falling mobs to lose their fall distance NBT when appearing
 - Fixed v0 save format not correctly upgrading to v1 from 24w11a to 24w20a (affecting major releases 1.20.5 and 1.20.6)
 - Improved armor save/resolve functions to include the vanishing curse enchantment in the root proxy chest item

assets/spawnanimations/lang/en_us.json

@@ -1,4 +1,8 @@
 {
+  "modmenu.summaryTranslation.spawnanimations": "Hostile mobs dig out of the ground or poof into existence when they spawn!",
+  "modmenu.descriptionTranslation.spawnanimations": "Hostile mobs dig out of the ground or poof into existence when they spawn!\n§lWorks with:§r Zombies, Husks, Drowned, Skeletons, Strays, Bogged, Spiders, Cave Spiders, Creepers, Slimes, Magma Cubes, Wither Skeletons, Hoglins, Zombified Piglins, Striders, Enderman and Giants.\nThis data pack is designed to be as unintrusive as possible. Hidden entities including their worn armor and tools will only be invisible and silent.\nExecute the command §o/function §ospawnanimations:settings§r for a world-specific settings menu and/or install MidnightLib for global settings across all worlds.",
+  "fml.menu.mods.info.description.spawnanimations": "Hostile mobs dig out of the ground or poof into existence when they spawn!\n\n§lWorks with:§r Zombies, Husks, Drowned, Skeletons, Strays, Bogged, Spiders, Cave Spiders, Creepers, Slimes, Magma Cubes, Wither Skeletons, Hoglins, Zombified Piglins, Striders, Enderman and Giants.\n\nThis data pack is designed to be as unintrusive as possible. Hidden entities including their worn armor and tools will only be invisible and silent.\n\nExecute the command §o/function §ospawnanimations:settings§r for a world-specific settings menu and/or install MidnightLib for global settings across all worlds.",
+
   "spawnanimations.midnightconfig.title": "Spawn Animations Configuration",
   "spawnanimations.midnightconfig.empty": "",
   "spawnanimations.midnightconfig.configure_ingame": "§dℹ Info:§r§f To configure this data pack on a world-to-world basis,",
@@ -13,7 +17,7 @@
   "spawnanimations.midnightconfig.activation_distance": "Activation Distance",
   "spawnanimations.midnightconfig.activation_distance.tooltip": "Default: §a20 blocks§f\nMobs closer to a player than this value will play the animation.\nSetting this to 0 will use the world-specific value.",
   "spawnanimations.midnightconfig.activation_mode": "Activation Mode",
-  "spawnanimations.midnightconfig.activation_mode.tooltip": "Default: §aClassic§f\n§nClassic§r: Out of range mobs will stay hidden until a player is in range\n§nVanilla§r: Out of range mobs will spawn normally",
+  "spawnanimations.midnightconfig.activation_mode.tooltip": "Default: §aClassic§f\n§nClassic§r: Out of range mobs will stay hidden until a player is in range\n§nVanilla§r: Out of range mobs will spawn normally\nWhen set to Vanilla, it is recommended to set the activation distance to at least 25 blocks to see the animation",
   "spawnanimations.midnightconfig.hide_worn_armor_and_tools": "Hide worn armor and tools",
   "spawnanimations.midnightconfig.hide_worn_armor_and_tools.tooltip": "Default: §aYes§f\nIf enabled, stores the worn armor and tools in the feet and in some versions leggings slot of a hidden entity.\n§6⚠ Note: This may impact worn armor and tool drop rates from farms when enabled.",
   "spawnanimations.midnightconfig.play_animation_on_unsupported_blocks": "Play block break animation on unsupported blocks",
@@ -26,7 +30,6 @@
   "spawnanimations.midnightconfig.enum.mode.CLASSIC": "§aClassic",
   "spawnanimations.midnightconfig.enum.mode.VANILLA": "§aVanilla",
 
-  "modmenu.summaryTranslation.spawnanimations": "Hostile mobs dig out of the ground or poof into existence when they spawn!",
   "modmenu.donate": "Donate",
   "modmenu.modrinth": "Modrinth",
   "modmenu.curseforge": "CurseForge",

data/spawnanimations/function/internal/entity/ehs/entity_specific/emissive_layer/hide.mcfunction

@@ -0,0 +1,12 @@
+##by Tschipcraft
+# Shrinks entities with an emissive layer to lowest possible scale (0.0625)
+# We do this using a negative scale modifier to not disturb the base scale value
+
+attribute @s minecraft:scale modifier add spawnanimations.ehs.scale -1000000000000000000000000000000 add_value
+tag @s add ts.sa.ehs.shrunk
+
+# Save initial position
+data modify storage spawnanimations:temp Pos set from entity @s Pos
+execute store result score @s ts.sa.prev_x run data get storage spawnanimations:temp Pos[0] 10
+execute store result score @s ts.sa.prev_y run data get storage spawnanimations:temp Pos[1] 10
+execute store result score @s ts.sa.prev_z run data get storage spawnanimations:temp Pos[2] 10

data/spawnanimations/function/internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance.mcfunction

@@ -0,0 +1,32 @@
+##by Tschipcraft
+# Shrunk entity @s is trying to escape an enclosure, when not to far away from its previous position we move it back
+
+# Get current position
+data modify storage spawnanimations:temp Pos set from entity @s Pos
+execute store result score #current ts.sa.prev_x run data get storage spawnanimations:temp Pos[0] 10
+execute store result score #current ts.sa.prev_y run data get storage spawnanimations:temp Pos[1] 10
+execute store result score #current ts.sa.prev_z run data get storage spawnanimations:temp Pos[2] 10
+
+scoreboard players operation #previous ts.sa.prev_x = @s ts.sa.prev_x
+scoreboard players operation #previous ts.sa.prev_y = @s ts.sa.prev_y
+scoreboard players operation #previous ts.sa.prev_z = @s ts.sa.prev_z
+
+# Calculate diff
+scoreboard players operation #previous ts.sa.prev_x -= #current ts.sa.prev_x
+scoreboard players operation #previous ts.sa.prev_y -= #current ts.sa.prev_y
+scoreboard players operation #previous ts.sa.prev_z -= #current ts.sa.prev_z
+
+# Make sure value is positive
+execute if score #previous ts.sa.prev_x matches ..0 run scoreboard players operation #previous ts.sa.prev_x *= #minus ts.sa.x
+execute if score #previous ts.sa.prev_y matches ..0 run scoreboard players operation #previous ts.sa.prev_y *= #minus ts.sa.x
+execute if score #previous ts.sa.prev_z matches ..0 run scoreboard players operation #previous ts.sa.prev_z *= #minus ts.sa.x
+
+# Add distances together
+scoreboard players operation #previous ts.sa.prev_x += #previous ts.sa.prev_y
+scoreboard players operation #previous ts.sa.prev_x += #previous ts.sa.prev_z
+
+# Move entity back to previous location if it moved not too far (distance times 10)
+execute if score #previous ts.sa.prev_x matches ..30 run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/move_back
+
+# Trigger animation any way
+function spawnanimations:internal/animation/dig_up/start

data/spawnanimations/function/internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_enclosure.mcfunction

@@ -0,0 +1,28 @@
+##by Tschipcraft
+# Checks if shrunk entity @s is trying to escape a potential enclosure
+
+# Inside block
+execute unless block ~ ~ ~ #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+
+# Model default enderman hitbox size
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^0.3 ^1.5 ^0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^0.3 ^1.5 ^-0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^-0.3 ^1.5 ^0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^-0.3 ^1.5 ^-0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^0.3 ^2.9 ^0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^0.3 ^2.9 ^-0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^-0.3 ^2.9 ^0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:enderman,tag=ts.sa.to_verify] unless block ^-0.3 ^2.9 ^-0.3 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+
+# Model default spider hitbox size
+execute as @s[type=minecraft:spider,tag=ts.sa.to_verify] unless block ~0.7 ~ ~0.7 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:spider,tag=ts.sa.to_verify] unless block ~0.7 ~ ~-0.7 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:spider,tag=ts.sa.to_verify] unless block ~-0.7 ~ ~-0.7 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:spider,tag=ts.sa.to_verify] unless block ~-0.7 ~ ~0.7 #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+execute as @s[type=minecraft:spider,tag=ts.sa.to_verify] unless block ~ ~0.9 ~ #spawnanimations:nonsolid run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/check_distance
+
+# Update position
+execute if entity @s[tag=ts.sa.to_verify] run data modify storage spawnanimations:temp Pos set from entity @s Pos
+execute if entity @s[tag=ts.sa.to_verify] store result score @s ts.sa.prev_x run data get storage spawnanimations:temp Pos[0] 10
+execute if entity @s[tag=ts.sa.to_verify] store result score @s ts.sa.prev_y run data get storage spawnanimations:temp Pos[1] 10
+execute if entity @s[tag=ts.sa.to_verify] store result score @s ts.sa.prev_z run data get storage spawnanimations:temp Pos[2] 10

data/spawnanimations/function/internal/entity/ehs/entity_specific/emissive_layer/prevent_enclosure_breach/move_back.mcfunction

@@ -0,0 +1,6 @@
+##by Tschipcraft
+
+# Move back to previous position
+execute store result entity @s Pos[0] double 0.1 run scoreboard players get @s ts.sa.prev_x
+execute store result entity @s Pos[1] double 0.1 run scoreboard players get @s ts.sa.prev_y
+execute store result entity @s Pos[2] double 0.1 run scoreboard players get @s ts.sa.prev_z

data/spawnanimations/function/internal/entity/ehs/entity_specific/emissive_layer/unhide.mcfunction

@@ -0,0 +1,5 @@
+##by Tschipcraft
+# Resets entities with an emissive layer that got their scale changed
+
+attribute @s minecraft:scale modifier remove spawnanimations.ehs.scale
+tag @s remove ts.sa.ehs.shrunk

data/spawnanimations/function/internal/entity/ehs/hide_exec.mcfunction

@@ -10,3 +10,4 @@ execute if score $hide_armor ts.sa.settings matches 1..2 as @s[type=#spawnanimat
 
 # Entity specific
 execute if entity @s[type=minecraft:creeper] run function spawnanimations:internal/entity/ehs/entity_specific/creeper/hide
+execute if entity @s[type=#spawnanimations:has_emissive_layer] run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/hide

data/spawnanimations/function/internal/entity/ehs/unhide.mcfunction

@@ -9,5 +9,6 @@ execute as @s[tag=ts.sa.ehs.saved] run function spawnanimations:internal/entity/
 
 # Entity specific
 execute if entity @s[type=minecraft:creeper] run function spawnanimations:internal/entity/ehs/entity_specific/creeper/unhide
+execute as @s[tag=ts.sa.ehs.shrunk] run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/unhide
 
 tag @s remove ts.sa.hidden