Add static scriptName property to multiple script classes (#7633)

* Add static scriptName property to multiple script classes

* Refactor scriptName properties in multiple script classes to camelCase format

Author: marklundin

examples/assets/scripts/misc/rotator.mjs

@@ -1,6 +1,8 @@
 import { Script } from 'playcanvas';
 
 class Rotator extends Script {
+    static scriptName = 'rotator';
+
     /**
      * @attribute
      */

scripts/esm/camera-controls.mjs

@@ -33,6 +33,8 @@ const EPSILON = 0.0001;
 const lerpRate = (damping, dt) => 1 - Math.pow(damping, dt * 1000);
 
 class CameraControls extends Script {
+    static scriptName = 'cameraControls';
+
     /**
      * Fired to clamp the position (Vec3).
      *

scripts/esm/camera-frame.mjs

@@ -333,6 +333,8 @@ class Dof {
 }
 
 class CameraFrame extends Script {
+    static scriptName = 'cameraFrame';
+
     /**
      * @attribute
      * @type {Rendering}

scripts/esm/first-person-controller.mjs

@@ -663,6 +663,8 @@ class GamePadInput {
 }
 
 class FirstPersonController extends Script {
+    static scriptName = 'firstPersonController';
+
     /**
      * @type {RigidBodyComponent}
      * @private

scripts/esm/grid.mjs

@@ -122,6 +122,8 @@ const fragmentCode = /* glsl */ `
 `;
 
 class Grid extends Script {
+    static scriptName = 'grid';
+
     /**
      * @type {number}
      */

scripts/esm/shadow-catcher.mjs

@@ -30,6 +30,8 @@ import {
  * app.root.addChild(shadowCatcher);
  */
 class ShadowCatcher extends Script {
+    static scriptName = 'shadowCatcher';
+
     /**
      * The scale of the shadow catcher.
      * @type {Vec3}

scripts/esm/xr-controllers.mjs

@@ -1,6 +1,8 @@
 import { Script } from 'playcanvas';
 
 class XrControllers extends Script {
+    static scriptName = 'xrControllers';
+
     /**
      * The base URL for fetching the WebXR input profiles.
      *

scripts/esm/xr-navigation.mjs

@@ -13,6 +13,8 @@ import { Color, Script, Vec3 } from 'playcanvas';
  * the controllers.
  */
 class XrNavigation extends Script {
+    static scriptName = 'xrNavigation';
+
     /** @type {Set<XrInputSource>} */
     inputSources = new Set();
 

src/framework/script/script.js

@@ -28,6 +28,8 @@ import { SCRIPT_INITIALIZE, SCRIPT_POST_INITIALIZE } from './constants.js';
  * @example
  * ```javascript
  * class EntityRotator extends Script {
+ *     static scriptName = 'entityRotator';
+ *
  *     update(dt) {
  *         this.entity.rotateLocal(0, 1, 0);
  *     }
@@ -48,6 +50,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('enable', () => {
      *             // Script Instance is now enabled
@@ -63,6 +66,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('disable', () => {
      *             // Script Instance is now disabled
@@ -79,6 +83,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('state', (enabled) => {
      *             console.log(`Script Instance is now ${enabled ? 'enabled' : 'disabled'}`);
@@ -94,6 +99,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('destroy', () => {
      *             // no longer part of the entity
@@ -117,6 +123,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('attr', (name, newValue, oldValue) => {
      *             console.log(`Attribute '${name}' changed from '${oldValue}' to '${newValue}'`);
@@ -125,6 +132,7 @@ export class Script extends EventHandler {
      * };
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('attr:speed', (newValue, oldValue) => {
      *             console.log(`Attribute 'speed' changed from '${oldValue}' to '${newValue}'`);
@@ -142,6 +150,7 @@ export class Script extends EventHandler {
      * @event
      * @example
      * export class PlayerController extends Script {
+     *     static scriptName = 'playerController';
      *     initialize() {
      *         this.on('error', (err, method) => {
      *             // caught an exception