🎨 Renderer name sanitization improvements & data pack compiler consistency fixes

- Renamed `safe_name` to `path_name` in `IRenderedAnimation` and `IRenderedNode`
- Added `storage_name` to `IRenderedAnimation` and `IRenderedNode`
- Renamed `minecraftUtil`'s `toSafeFunctionName` to  `sanitizePathName`
- Added `sanitizeStorageKey` to `minecraftUtil`
- Fixed `sanitizePathName` replacing repeated underscores from source name with a single underscore.
- Fixed some minor inconsistencies in .mcb files between data pack compiler versions.

Author: SnaveSutit

src/blueprintFormat.ts

@@ -6,7 +6,7 @@ import { BillboardMode, BoneConfig, LocatorConfig } from './nodeConfigs'
 import { process } from './systems/modelDataFixerUpper'
 import { events } from './util/events'
 import { injectSvelteCompomponent } from './util/injectSvelteComponent'
-import { toSafeFuntionName } from './util/minecraftUtil'
+import { sanitizePathName } from './util/minecraftUtil'
 import { addProjectToRecentProjects } from './util/misc'
 import { Valuable } from './util/stores'
 import { translate } from './util/translation'
@@ -164,7 +164,7 @@ export function convertToBlueprint() {
 	}
 	for (const animation of Blockbench.Animation.all) {
 		animation.createUniqueName(Blockbench.Animation.all.filter(a => a !== animation))
-		animation.name = toSafeFuntionName(animation.name)
+		animation.name = sanitizePathName(animation.name)
 	}
 	for (const cube of Cube.all) {
 		cube.setUVMode(false)
@@ -340,7 +340,7 @@ export const BLUEPRINT_CODEC = new Blockbench.Codec('animated_java_blueprint', {
 			parseGroups(model.outliner)
 
 			for (const group of Group.all) {
-				group.name = toSafeFuntionName(group.name)
+				group.name = sanitizePathName(group.name)
 			}
 		}
 

src/interface/dialog/blueprintSettings.ts

@@ -3,7 +3,7 @@ import { defaultValues, ExportMode } from '../../blueprintSettings'
 import BlueprintSettingsDialogSvelteComponent from '../../components/blueprintSettingsDialog.svelte'
 import { PACKAGE } from '../../constants'
 import { MinecraftVersion } from '../../systems/datapackCompiler/mcbFiles'
-import { toSafeFuntionName } from '../../util/minecraftUtil'
+import { sanitizePathName } from '../../util/minecraftUtil'
 import { Valuable } from '../../util/stores'
 import { SvelteDialog } from '../../util/svelteDialog'
 import { translate } from '../../util/translation'
@@ -28,7 +28,7 @@ function getSettings() {
 			if (!value) {
 				return defaultValues.export_namespace
 			}
-			return toSafeFuntionName(value)
+			return sanitizePathName(value)
 		}),
 		resourcePackExportMode: new Valuable(
 			Project!.animated_java.resource_pack_export_mode as string

src/interface/importAJModelLoader.ts

@@ -1,13 +1,13 @@
 import { SvelteComponentDev } from 'svelte/internal'
+import { BLUEPRINT_CODEC, IBlueprintFormatJSON } from '../blueprintFormat'
 import ImportAjModelLoaderDialog from '../components/importAJModelLoaderDialog.svelte'
 import { PACKAGE } from '../constants'
+import * as ModelDatFixerUpper from '../systems/modelDataFixerUpper'
 import { injectSvelteCompomponent } from '../util/injectSvelteComponent'
+import { sanitizePathName } from '../util/minecraftUtil'
 import { createModelLoader } from '../util/moddingTools'
 import { translate } from '../util/translation'
 import { openUnexpectedErrorDialog } from './dialog/unexpectedError'
-import * as ModelDatFixerUpper from '../systems/modelDataFixerUpper'
-import { BLUEPRINT_CODEC, IBlueprintFormatJSON } from '../blueprintFormat'
-import { toSafeFuntionName } from '../util/minecraftUtil'
 
 let activeComponent: SvelteComponentDev | null = null
 
@@ -52,7 +52,7 @@ export function convertAJModelToBlueprint(path: string) {
 			name: 'Upgrade .ajmodel to Blueprint',
 			path,
 		})
-		blueprint.blueprint_settings!.export_namespace ??= toSafeFuntionName(Project!.name)
+		blueprint.blueprint_settings!.export_namespace ??= sanitizePathName(Project!.name)
 
 		requestAnimationFrame(() => {
 			Project!.save_path = ''

src/outliner/util.ts

@@ -1,10 +1,10 @@
-import { toSafeFuntionName } from '../util/minecraftUtil'
+import { sanitizePathName } from '../util/minecraftUtil'
 import { TextDisplay } from './textDisplay'
 import { VanillaBlockDisplay } from './vanillaBlockDisplay'
 import { VanillaItemDisplay } from './vanillaItemDisplay'
 
 export function sanitizeOutlinerElementName(name: string, elementUUID: string): string {
-	name = toSafeFuntionName(name)
+	name = sanitizePathName(name)
 	let otherNodes: OutlinerElement[] = [
 		...VanillaBlockDisplay.all,
 		...Group.all,

src/systems/animationRenderer.ts

@@ -1,3 +1,4 @@
+import * as crypto from 'crypto'
 import {
 	getKeyframeCommands,
 	getKeyframeExecuteCondition,
@@ -8,10 +9,9 @@ import {
 import { TextDisplay } from '../outliner/textDisplay'
 import { VanillaBlockDisplay } from '../outliner/vanillaBlockDisplay'
 import { VanillaItemDisplay } from '../outliner/vanillaItemDisplay'
-import { toSafeFuntionName } from '../util/minecraftUtil'
+import { sanitizePathName, sanitizeStorageKey } from '../util/minecraftUtil'
 import { eulerFromQuaternion, roundToNth } from '../util/misc'
 import { AnyRenderedNode, IRenderedRig } from './rigRenderer'
-import * as crypto from 'crypto'
 
 export function correctSceneAngle() {
 	main_preview.controls.rotateLeft(Math.PI)
@@ -86,8 +86,11 @@ export interface IRenderedFrame {
 
 export interface IRenderedAnimation {
 	name: string
+	/** A sanitized version of {@link IRenderedAnimation.name} that is safe to use in a path in a data pack or resource pack.*/
+	path_name: string
+	/** A sanitized version of {@link IRenderedAnimation.name} that is safe to use as a key in a storage object. */
+	storage_name: string
 	uuid: string
-	safe_name: string
 	loop_delay: number
 	frames: IRenderedFrame[]
 	/**
@@ -302,8 +305,9 @@ export function updatePreview(animation: _Animation, time: number) {
 export function renderAnimation(animation: _Animation, rig: IRenderedRig) {
 	const rendered = {
 		name: animation.name,
+		path_name: sanitizePathName(animation.name),
+		storage_name: sanitizeStorageKey(animation.name),
 		uuid: animation.uuid,
-		safe_name: toSafeFuntionName(animation.name).replaceAll('.', '_'),
 		loop_delay: Number(animation.loop_delay) || 0,
 		frames: [],
 		duration: 0,