🚧 Locator Improvements / Fixes

- Fixed Locators not being migrated from `.ajmodel`s properly. (#188)
- Added optional MC-Build syntax to all command inputs.
- Fixed exportOver Action repeatedly prompting the user for save location.

Author: SnaveSutit

package.json

@@ -97,7 +97,7 @@
 		"generic-stream": "^1.2.6",
 		"marked": "^4.3.0",
 		"marked-gfm-heading-id": "^3.0.0",
-		"mc-build": "^3.3.1",
+		"mc-build": "^3.3.2",
 		"svelte-ace": "^1.0.21",
 		"svelte-dnd-action": "^0.9.38"
 	}

src/lang/en.yml

@@ -114,7 +114,9 @@ animated_java.dialog.blueprint_settings.data_pack.error.missing_pack_mcmeta: The
 animated_java.dialog.blueprint_settings.data_pack.error.missing_data_folder: The selected Data Pack is missing a data folder!
 
 animated_java.dialog.blueprint_settings.summon_commands.title: On-Summon Commands
-animated_java.dialog.blueprint_settings.summon_commands.description: Commands to run as the root entity when summoned. Treat this text input as a normal mcfunction.
+animated_java.dialog.blueprint_settings.summon_commands.description: |-
+    Commands to run as the root entity when summoned.
+    Treat this text input as a .mcfunction file. (Also supports MC-Build syntax!)
 
 animated_java.dialog.blueprint_settings.interpolation_duration.title: Interp Duration
 animated_java.dialog.blueprint_settings.interpolation_duration.description: The duration of the smoothing between keyframes in ticks. This is the time it takes for the model to transition from one keyframe to the next. Higher values will cause animations to lose precision. Generally, you want this to have a value of 1 or 2.
@@ -189,12 +191,14 @@ animated_java.dialog.locator_config.entity_type.error.empty: Entity Type cannot
 animated_java.dialog.locator_config.entity_type.warning.invalid: The selected entity type doesn't exist in Minecraft {0}
 
 animated_java.dialog.locator_config.summon_commands.title: On-Summon Commands
-animated_java.dialog.locator_config.summon_commands.description: Commands to run as the Locator's entity when summoned. Treat this text input as a normal mcfunction.
+animated_java.dialog.locator_config.summon_commands.description: |-
+    Commands to run as the Locator's entity when summoned.
+    Treat this text input as a .mcfunction file. (Also supports MC-Build syntax!)
 
 animated_java.dialog.locator_config.ticking_commands.title: Ticking Commands
 animated_java.dialog.locator_config.ticking_commands.description: |-
-    Commands to run every tick at the Locator's position. Treat this text input as a normal mcfunction.
-    NOTE: These commands will only run while an animation is playing.
+    Commands to run every tick at the Locator's position.
+    Treat this text input as a .mcfunction file. (Also supports MC-Build syntax!)
 
 ## Text Display Config Dialog
 animated_java.dialog.text_display_config.title: Text Display Config
@@ -338,8 +342,9 @@ animated_java.panel.keyframe.variant.title: Variant
 animated_java.panel.keyframe.variant.description: The Variant to apply to the keyframe.
 
 animated_java.panel.keyframe.commands.title: Commands
-animated_java.panel.keyframe.commands.description: Commands to run when the keyframe is reached. Treat this text input as a normal mcfunction.
-
+animated_java.panel.keyframe.commands.description: |-
+    Commands to run when the keyframe is reached.
+    Treat this text input as a .mcfunction file. (Also supports MC-Build syntax!)
 animated_java.panel.keyframe.execute_condition.title: Execute Condition
 animated_java.panel.keyframe.execute_condition.description: A condition that must be met for the keyframe to execute. Treat this text input as the sub-commands of an execute command.
 

src/mods/exportOverActionMod.ts

@@ -1,6 +1,7 @@
 import { BLUEPRINT_CODEC, BLUEPRINT_FORMAT } from '../blueprintFormat'
 import { PACKAGE } from '../constants'
 import { createBlockbenchMod } from '../util/moddingTools'
+import { translate } from '../util/translation'
 
 createBlockbenchMod(
 	`${PACKAGE.name}:exportOverAction`,
@@ -12,10 +13,23 @@ createBlockbenchMod(
 		context.action.click = (event: Event) => {
 			if (!Project || !Format) return
 			if (Format.id === BLUEPRINT_FORMAT.id) {
-				if (Project.save_path || Project.export_path) {
-					Project.save_path = Project.save_path || Project.export_path
+				const path = Project.save_path || Project.export_path
+				if (path) {
+					if (fs.existsSync(PathModule.dirname(path))) {
+						Project.save_path = path
+						BLUEPRINT_CODEC.write(BLUEPRINT_CODEC.compile(), path)
+					} else {
+						console.error(
+							`Failed to export Animated Java Blueprint, file location '${path}' does not exist!`
+						)
+						Blockbench.showMessageBox({
+							title: translate('error.blueprint_export_path_doesnt_exist.title'),
+							message: translate('error.blueprint_export_path_doesnt_exist', path),
+						})
+					}
+				} else {
+					BLUEPRINT_CODEC.export()
 				}
-				BLUEPRINT_CODEC.export()
 			} else {
 				context.originalClick.call(context.action, event)
 			}

src/systems/animated_java.mcb

@@ -166,13 +166,21 @@ dir <%export_namespace%> {
 					execute on passengers if entity @s[tag=<%TAGS.PROJECT_DATA(export_namespace)%>] run { with entity @s data.positions.locators.<%node.name%>
 						$execute as $(uuid) positioned ^$(posx) ^$(posy) ^$(posz) rotated ~$(roty) ~$(rotx) run {
 							tp @s ~ ~ ~ ~ ~
-							<%node.config?.ticking_commands || ''%>
+							<%%
+								if (node.config?.ticking_commands) {
+									emit.mcb(node.config.ticking_commands)
+								}
+							%%>
 						}
 					}
 				} ELSE IF (node.config?.ticking_commands) {
 					execute on passengers if entity @s[tag=<%TAGS.PROJECT_DATA(export_namespace)%>] run { with entity @s data.positions.locators.<%node.name%>
 						$execute positioned ^$(posx) ^$(posy) ^$(posz) rotated ~$(roty) ~$(rotx) run {
-							<%node.config.ticking_commands%>
+							<%%
+								if (node.config?.ticking_commands) {
+									emit.mcb(node.config.ticking_commands)
+								}
+							%%>
 						}
 					}
 				}
@@ -388,7 +396,7 @@ dir <%export_namespace%> {
 														~<%roundTo(node.rot.x, 10)%> \
 														~<%roundTo(node.rot.y, 10)%> \
 												run {
-													<%node.commands%>
+													<%%emit.mcb(node.commands)%%>
 												}
 											}
 										} ELSE IF (node.type === 'camera') {
@@ -448,7 +456,11 @@ dir <%export_namespace%> {
 						execute as @e[type=item_display,tag=<%TAGS.NEW()%>,limit=1,distance=..0.01] on passengers if entity @s[tag=<%TAGS.GLOBAL_DATA()%>] run {
 							data modify entity @s data.positions.locators.<%locator.name%>.uuid set from storage aj:uuid main.out
 						}
-						<%locator.config.summon_commands%>
+						<%%
+							if (locator.config.summon_commands) {
+								emit.mcb(locator.config.summon_commands)
+							}
+						%%>
 					}
 				}
 			}
@@ -520,7 +532,7 @@ dir <%export_namespace%> {
 			data modify entity @s teleport_duration set value <%teleportation_duration%>
 			execute on passengers run data modify entity @s teleport_duration set value <%teleportation_duration%>
 			# Custom Summon Commands
-			<%custom_summon_commands%>
+			<%%if (custom_summon_commands) emit.mcb(custom_summon_commands)%%>
 			# Custom Summon Commands
 
 			# Run the on_summon function for the root entity.
@@ -552,7 +564,7 @@ dir <%export_namespace%> {
 
 			execute on passengers if entity @s[tag=<%TAGS.GLOBAL_DATA()%>] run {
 				REPEAT (Object.values(rig.nodeMap).filter(v => v.type === 'locator' && v.config?.use_entity)) as locator {
-					execute run block zzz/kill { with entity @s data.positions.locators.<%locator.name%>
+					block zzz/kill { with entity @s data.positions.locators.<%locator.name%>
 						$kill $(uuid)
 					}
 				}

src/systems/modelDataFixerUpper.ts

@@ -2,6 +2,7 @@ import { IBlueprintFormatJSON, getDefaultProjectSettings } from '../blueprintFor
 import { BoneConfig } from '../nodeConfigs'
 import { PACKAGE } from '../constants'
 import { openUnexpectedErrorDialog } from '../interface/unexpectedErrorDialog'
+import { NbtCompound, NbtList, NbtString, NbtTag } from 'deepslate'
 
 export function process(model: any): any {
 	if (model.meta.model_format === 'animatedJava/ajmodel') {
@@ -268,6 +269,54 @@ function updateModelTo1_0pre1(model: any) {
 	model.outliner.forEach(recurseOutliner)
 	blueprint.outliner = model.outliner
 
+	for (const element of blueprint.elements) {
+		if (element.type === 'locator') {
+			element.config = {
+				use_entity: true,
+			}
+			if (element.entity_type) element.config.entity_type = element.entity_type
+			if (element.nbt) {
+				const summon_commands: string[] = []
+
+				const recursePassengers = (stringNbt: string): string[] => {
+					const nbt = NbtTag.fromString(stringNbt) as NbtCompound
+					if (!(nbt instanceof NbtCompound)) throw new Error('NBT is not a compound')
+					const passengers = nbt.get('Passengers') as NbtList<NbtCompound>
+					if (passengers) {
+						console.log('Found passengers')
+						const commands = passengers.map(p => {
+							const id = (p.get('id') as NbtString).getAsString()
+							p.delete('id')
+							const data = p.toString()
+							return `execute summon ${id} run {\n\t${[
+								`data merge entity @s ${data}`,
+								`tag @s add to_mount`,
+								...recursePassengers(data),
+							].join('\n\t')}\n}`
+						})
+						commands.push(
+							`ride @e[tag=to_mount,distance=..0.01] mount @s`,
+							`execute on passengers run tag @s remove to_mount`
+						)
+						return commands
+					}
+					return []
+				}
+
+				try {
+					summon_commands.push(...recursePassengers(element.nbt as string))
+				} catch (e) {
+					console.error('Failed to parse NBT', element.nbt)
+					console.error(e)
+				}
+				if (summon_commands.length === 0) {
+					summon_commands.push(`data merge entity @s ${element.nbt as string}`)
+				}
+				element.config.summon_commands = summon_commands.join('\n')
+			}
+		}
+	}
+
 	for (const variant of variants) {
 		const includedBones = variant.affectedBones.map((v: any) => v.value as string)
 		let excludedBones: string[]

yarn.lock

@@ -2414,10 +2414,10 @@ matcher@^3.0.0:
   dependencies:
     escape-string-regexp "^4.0.0"
 
-mc-build@^3.3.1:
-  version "3.3.1"
-  resolved "https://registry.yarnpkg.com/mc-build/-/mc-build-3.3.1.tgz#9eb10a18c465e1ff9c5e1ef5fe366f738d93aa4d"
-  integrity sha512-Na747ajLA47MW1vHieRNT0hKvjIWQhijMa0yHNowOxLiTn6nOqRWtVl1xt4uaxmP6cCV7uaAy+7CN7/dXqo0Gw==
+mc-build@^3.3.2:
+  version "3.3.2"
+  resolved "https://registry.yarnpkg.com/mc-build/-/mc-build-3.3.2.tgz#0800825d3b9ac87a70abebc34ef3b26eb66b1c15"
+  integrity sha512-mOpTW2gXNLwOYlLRyIhItHROJGaRfWhWV4SdWNNFIwGUhzEkyew9sZuJZMUNaIC/kDblCb7FHlz1FHcn0ocXxA==
   dependencies:
     tsx "^4.7.2"