Custom script names when using the new Script-class with ESM

Help & Support
1

Hey everyone,

We’re considering upgrading our projects to the new ESM scripting system by moving away from the now deprecated ScriptType-class and using the new Script-class instead. I’ve noticed scripts can now be registered with the PlayCanvas engine by exporting them from an .mjs file:

export class FooBar extends Script { ... }

Previously we’d use pc.registerScript(scriptClass, scriptName) to register our ScriptType-based scripts with names that use PascalCase (e.g. “PlayerController”) and sometimes with spaces and other characters (e.g. “First-Person Camera Controller”). Is there any way to use custom script names with the new ESM approach?

I’ve looked into how scripts are loaded at runtime and it doesn’t give me much hope:

Module loading
Module loading732×403 59.6 KB

It seems the script’s class name is directly converted to lowerCamelCase and used as the script’s name. This would mean all uses of our scripts in our projects will break (that’s hundreds of scripts) since their names don’t follow the lowerCamelCase format. Are there any plans to support custom script names again? We’ve relied on this feature for years and we simply can’t just go on without it as it would require manually repairing many, many entities and templates throughout our projects.

Thanks for the help.

2

@Mark_Lundin is an expert here, but he’s away till mid next week.

1 Like
3

yep, this is something we’re looking at. it also has other implications regarding bundling. Terser mangles Script name · Issue #7580 · playcanvas/engine · GitHub

1 Like
4

Thanks for the clarification, that’s great to hear :smile: Incidentally that’s also one of the main reasons we supply a custom script name when invoking registerScript (we use an obfuscator and a minifier in our Webpack build pipeline).