✨ Added a root onApplyFunction to variants

Author: SnaveSutit

TODO.md

@@ -5,6 +5,7 @@
 - [ ] Add Variants to the UndoSystem (Blocked by vanilla Blockbench not supporting custom undo actions).
 - [ ] Add an option to generate a `damage_flash` variant for mob-type entities.
 - [ ] Add a fix for 360 rotation snap by using `set_frame` instead of `apply_frame` for the first frame of the animation.
+- [ ] Add a toggle for node custom names.
 
 # Data Pack Compiler
 

src/dialogs/variantConfig/variantConfig.svelte

@@ -8,6 +8,7 @@
 </script>
 
 <script lang="ts">
+	import CodeInput from '../../svelteComponents/dialogItems/codeInput.svelte'
 	import Collection from '../../svelteComponents/dialogItems/collection.svelte'
 	import { getAvailableNodes } from '../../util/excludedNodes'
 
@@ -18,6 +19,7 @@
 	export let textureMap: TextureMap
 	export let generateNameFromDisplayName: Observable<boolean>
 	export let excludedNodes: Observable<CollectionItem[]>
+	export let onApplyFunction: Observable<string>
 
 	const AVAILABLE_TEXTURES = [...Texture.all]
 	const PRIMARY_TEXTURES = [...Texture.all]
@@ -222,6 +224,14 @@
 		/>
 	{/if}
 
+	<CodeInput
+		label={translate('dialog.variant_config.on_apply_function.title')}
+		bind:value={onApplyFunction}
+		tooltip={translate('dialog.variant_config.on_apply_function.description')}
+		syntax="mcfunction"
+		defaultValue={''}
+	></CodeInput>
+
 	<div class="uuid">
 		{$uuid}
 	</div>

src/dialogs/variantConfig/variantConfig.ts

@@ -13,6 +13,7 @@ export function openVariantConfigDialog(variant: Variant) {
 	const textureMap = variant.textureMap.copy()
 	const generateNameFromDisplayName = observable(variant.generateNameFromDisplayName)
 	const excludedNodes = observable(variant.excludedNodes)
+	const onApplyFunction = observable(variant.onApplyFunction ?? '')
 
 	new SvelteDialog({
 		id: `${PACKAGE.name}:variantConfig`,
@@ -27,6 +28,7 @@ export function openVariantConfigDialog(variant: Variant) {
 			textureMap,
 			generateNameFromDisplayName,
 			excludedNodes,
+			onApplyFunction,
 		},
 		disableKeybinds: true,
 		onConfirm() {
@@ -36,6 +38,7 @@ export function openVariantConfigDialog(variant: Variant) {
 			variant.textureMap = textureMap
 			variant.generateNameFromDisplayName = generateNameFromDisplayName.get()
 			variant.excludedNodes = excludedNodes.get()
+			variant.onApplyFunction = onApplyFunction.get().trim()
 			EVENTS.UPDATE_VARIANT.publish(variant)
 			variant.select()
 

src/formats/blueprint/index.ts

@@ -109,6 +109,10 @@ export interface IBlueprintVariantJSON {
 	 * Whether or not this is the default Variant
 	 */
 	is_default?: true
+	/**
+	 * A list of commands to run when applying the Variant
+	 */
+	on_apply_function?: string
 }
 
 export interface ICollectionJSON {

src/lang/en.yml

@@ -746,8 +746,19 @@ animated_java:
         description: A list of nodes to include in the Variant. Only these nodes will be changed when applying the Variant.
       swap_columns_button:
         tooltip: Swap Lists
+      on_apply_function:
+        title: On-Apply Function
+        description: |-
+          [Markdown]
+          Commands to run `as` and `at` the root entity when the Variant is applied.
+
+          Treat this text input as if it were a `.mcfunction` file.
+
+          Supports [MC-Build](https://mcbuild.dev) syntax.
+
     upgrade_old_aj_model_loader:
       title: Update .ajmodel
+
     animation_properties:
       title: Animation Properties (%s)
       animation_name:

src/variants.ts

@@ -84,6 +84,7 @@ export class Variant {
 	textureMap: TextureMap
 	isDefault = false
 	generateNameFromDisplayName = true
+	onApplyFunction?: string
 	excludedNodes: CollectionItem[] = []
 
 	constructor(displayName: string, isDefault = false) {
@@ -149,6 +150,7 @@ export class Variant {
 			uuid: this.uuid,
 			texture_map: Object.fromEntries(this.textureMap.map),
 			excluded_nodes: this.excludedNodes.map(item => item.value),
+			on_apply_function: this.onApplyFunction,
 		}
 		if (this.isDefault) {
 			json.is_default = true
@@ -185,6 +187,7 @@ export class Variant {
 				return group ? { name: group.name, value: uuid } : undefined
 			})
 			.filter(Boolean) as CollectionItem[]
+		variant.onApplyFunction = json.on_apply_function
 		return variant
 	}