✨ Add locator on-remove function

Author: SnaveSutit

src/components/locatorConfigDialog.svelte

@@ -34,6 +34,7 @@
 	export let entityType: Valuable<string>
 	export let syncPassengerRotation: Valuable<boolean>
 	export let onSummonFunction: Valuable<string>
+	export let onRemoveFunction: Valuable<string>
 	export let onTickFunction: Valuable<string>
 </script>
 
@@ -76,6 +77,17 @@
 				bind:value={onSummonFunction}
 				defaultValue=""
 			/>
+
+			<CodeInput
+				label={translate('dialog.locator_config.on_remove_function.title')}
+				tooltip={$useEntity
+					? translate(
+							'dialog.locator_config.on_remove_function.description_with_use_entity'
+						)
+					: translate('dialog.locator_config.on_remove_function.description')}
+				bind:value={onRemoveFunction}
+				defaultValue=""
+			/>
 		{/if}
 
 		<CodeInput

src/formats/blueprint/index.ts

@@ -66,6 +66,7 @@ export interface IBlueprintLocatorConfigJSON {
 	entity_type?: LocatorConfig['entityType']
 	sync_passenger_rotation?: LocatorConfig['syncPassengerRotation']
 	on_summon_function?: LocatorConfig['__onSummonFunction']
+	on_remove_function?: LocatorConfig['__onRemoveFunction']
 	on_tick_function?: LocatorConfig['__onTickFunction']
 }
 

src/interface/dialog/locatorConfig.ts

@@ -15,6 +15,7 @@ export function openLocatorConfigDialog(locator: Locator) {
 	const entityType = new Valuable(locatorConfig.entityType)
 	const syncPassengerRotation = new Valuable(locatorConfig.syncPassengerRotation)
 	const onSummonFunction = new Valuable(locatorConfig.onSummonFunction)
+	const onRemoveFunction = new Valuable(locatorConfig.onRemoveFunction)
 	const onTickFunction = new Valuable(locatorConfig.onTickFunction)
 
 	new SvelteDialog({
@@ -28,6 +29,7 @@ export function openLocatorConfigDialog(locator: Locator) {
 				entityType,
 				syncPassengerRotation,
 				onSummonFunction,
+				onRemoveFunction,
 				onTickFunction,
 			},
 		},
@@ -37,6 +39,7 @@ export function openLocatorConfigDialog(locator: Locator) {
 			locatorConfig.entityType = entityType.get()
 			locatorConfig.syncPassengerRotation = syncPassengerRotation.get()
 			locatorConfig.onSummonFunction = onSummonFunction.get()
+			locatorConfig.onRemoveFunction = onRemoveFunction.get()
 			locatorConfig.onTickFunction = onTickFunction.get()
 
 			locator.config = locatorConfig.toJSON()

src/lang/en.yml

@@ -382,6 +382,16 @@ animated_java.dialog.locator_config.on_summon_function.description_with_use_enti
 
   Supports [MC-Build](https://mcbuild.dev) syntax.
 
+animated_java.dialog.locator_config.on_remove_function.title: On-Remove Function
+animated_java.dialog.locator_config.on_remove_function.description: |-
+  Commands to run `as` the root entity and `at` the Locator's position when the rig is removed.
+
+  Supports [MC-Build](https://mcbuild.dev) syntax.
+animated_java.dialog.locator_config.on_remove_function.description_with_use_entity: |-
+  Commands to run `as` and `at` the Locator's entity when removed.
+
+  Supports [MC-Build](https://mcbuild.dev) syntax.
+
 animated_java.dialog.locator_config.on_tick_function.title: On-Tick Function
 animated_java.dialog.locator_config.on_tick_function.description: |-
   Commands to run `at` the Locator's position every tick.

src/nodeConfigs.ts

@@ -350,6 +350,7 @@ export class LocatorConfig {
 	private __entityType?: string
 	private __syncPassengerRotation?: boolean
 	private __onSummonFunction?: string
+	private __onRemoveFunction?: string
 	private __onTickFunction?: string
 
 	getDefault(): LocatorConfig {
@@ -358,6 +359,7 @@ export class LocatorConfig {
 			entity_type: 'minecraft:pig',
 			sync_passenger_rotation: false,
 			on_summon_function: '',
+			on_remove_function: '',
 			on_tick_function: '',
 		})
 	}
@@ -398,6 +400,15 @@ export class LocatorConfig {
 		this.__onSummonFunction = value
 	}
 
+	get onRemoveFunction(): NonNullable<LocatorConfig['__onRemoveFunction']> {
+		if (this.__onRemoveFunction !== undefined) return this.__onRemoveFunction
+		const defaultConfig = this.getDefault()
+		return defaultConfig.onRemoveFunction
+	}
+	set onRemoveFunction(value: NonNullable<LocatorConfig['__onRemoveFunction']>) {
+		this.__onRemoveFunction = value
+	}
+
 	get onTickFunction(): NonNullable<LocatorConfig['__onTickFunction']> {
 		if (this.__onTickFunction !== undefined) return this.__onTickFunction
 		const defaultConfig = this.getDefault()
@@ -413,6 +424,7 @@ export class LocatorConfig {
 			entity_type: this.__entityType,
 			sync_passenger_rotation: this.__syncPassengerRotation,
 			on_summon_function: this.__onSummonFunction,
+			on_remove_function: this.__onRemoveFunction,
 			on_tick_function: this.__onTickFunction,
 		})
 	}
@@ -425,6 +437,8 @@ export class LocatorConfig {
 			config.__syncPassengerRotation = json.sync_passenger_rotation
 		if (json.on_summon_function !== undefined)
 			config.__onSummonFunction = json.on_summon_function
+		if (json.on_remove_function !== undefined)
+			config.__onRemoveFunction = json.on_remove_function
 		if (json.on_tick_function !== undefined) config.__onTickFunction = json.on_tick_function
 		return config
 	}
@@ -439,6 +453,7 @@ export class LocatorConfig {
 			this.entityType === other.entityType &&
 			this.syncPassengerRotation === other.syncPassengerRotation &&
 			this.onSummonFunction === other.onSummonFunction &&
+			this.onRemoveFunction === other.onRemoveFunction &&
 			this.onTickFunction === other.onTickFunction
 		)
 	}

src/systems/datapackCompiler/1.20.4/animation.mcb

@@ -890,6 +890,35 @@ dir remove {
 			if (on_remove_function) emit.mcb(on_remove_function)
 		%%>
 
+		IF (has_entity_locators) {
+			execute on passengers if entity @s[tag=<%TAGS.GLOBAL_DATA()%>] run block as_data {
+				REPEAT (Object.values(rig.nodes).filter(node => node.type === 'locator')) as locator {
+					IF (locator.config?.on_remove_function) {
+						IF (locator.config.use_entity) {
+							block as_locator_<%locator.storage_name%> { with entity @s data.locators.<%locator.storage_name%>
+								$execute as $(uuid) at @s run block locator_<%locator.storage_name%>_on_remove {
+									<%%
+										emit.mcb(locator.config.on_remove_function)
+									%%>
+								}
+							}
+						} ELSE {
+							block at_locator_<%locator.storage_name%> { with entity @s data.locators.<%locator.storage_name%>
+								$execute \
+									positioned ^$(px) ^$(py) ^$(pz) \
+									rotated ~$(ry) ~$(rx) \
+								run block locator_<%locator.storage_name%>_on_remove {
+									<%%
+										emit.mcb(locator.config.on_remove_function)
+									%%>
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+
 		function ./this/without_on_remove_function
 	}