Deprecate Internal Scripts (#193)

* Enhance script definitions with static scriptName property

- Added static scriptName properties to various scripts including Rotator, AutoRotator, Grid, ShadowCatcher, and OrbitCamera classes for improved identification.
- Marked Grid and ShadowCatcher scripts as deprecated, recommending alternative implementations from the PlayCanvas library.
- Updated documentation comments to guide users on migration to the new script structure.

* Deprecate Grid and ShadowCatcher scripts with warning messages

- Added deprecation warnings to the Grid and ShadowCatcher scripts, advising users to transition to the respective implementations from the PlayCanvas library.
- Imported the `warnOnce` utility to facilitate the warning mechanism in both scripts.

* Deprecate Grid and ShadowCatcher scripts

- Added a changeset to mark the Grid and ShadowCatcher scripts as deprecated, indicating they will be removed in the next major release. This follows previous warnings and encourages users to transition to alternative implementations from the PlayCanvas library.

* Update .changeset/better-mice-marry.md

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: marklundin

.changeset/better-mice-marry.md

@@ -0,0 +1,5 @@
+---
+"@playcanvas/react": patch
+---
+
+Deprecated Grid and ShadowCatcher scripts. These will be removed in the next major release

packages/lib/src/components/Script.tsx

@@ -15,6 +15,8 @@ import { SubclassOf } from "../utils/types-utils.ts";
  * @example
  * // A Rotator script that rotates the entity around the Y axis
  * class Rotator extends Script {
+ *  static scriptName = 'rotator';
+ *
  *  update(dt: number) {
  *    this.entity.rotate(0, 1, 0, dt);
  *  }

packages/lib/src/scripts/auto-rotator/auto-rotator.tsx

@@ -5,6 +5,8 @@ const smoothStep = (x: number): number =>
 
 
 class AutoRotator extends Script {
+  static scriptName = 'autoRotator';
+  
   speed: number = 4;
   pitchSpeed: number = 0;
   pitchAmount: number = 1;

packages/lib/src/scripts/infinite-grid/infinite-grid.js

@@ -13,6 +13,7 @@ import {
     BLENDMODE_SRC_ALPHA,
     BLENDEQUATION_ADD
 } from 'playcanvas';
+import { warnOnce } from '../../utils/validation.ts';
 
 const vsCode = /* glsl*/ `
     uniform mat4 camera_matrix;
@@ -178,10 +179,24 @@ const attributes = {
     vertex_position: SEMANTIC_POSITION
 };
 
+/**
+ * @deprecated This script is deprecated and will be removed in the next major version.
+ *
+ * Use {@link https://github.com/playcanvas/engine/tree/main/scripts/esm/grid.mjs | Grid} from `playcanvas` instead.
+ *
+ * ```tsx
+ * import { Grid } from "playcanvas/scripts/esm/grid.mjs";
+ *
+ * export const MyScript = () => <Script script={Grid} />;
+ * ```
+ */
 export class Grid extends Script {
+    static scriptName = 'grid';
 
     initialize() {
 
+        warnOnce('This script is deprecated and will be removed in the next major version. Use the `Grid` from `playcanvas` instead.');
+
         const layerName = 'World';
 
         const device = this.app.graphicsDevice;

packages/lib/src/scripts/orbit-controls/orbit-camera.js

@@ -5,7 +5,7 @@ import {
 } from 'playcanvas';
 
 export class OrbitCamera extends Script {
-    static __name = 'orbitCamera';
+    static scriptName = 'orbitCamera';
 
     /**
      * @attribute
@@ -443,7 +443,7 @@ export class OrbitCamera extends Script {
 
 
 export class OrbitCameraInputMouse extends Script {
-    static __name = 'orbitCameraInputMouse';
+    static scriptName = 'orbitCameraInputMouse';
 
     /**
      * How fast the camera moves around the orbit. Higher is faster
@@ -574,7 +574,7 @@ export class OrbitCameraInputMouse extends Script {
 }
 
 export class OrbitCameraInputTouch extends Script {
-    static __name = 'orbitCameraInputTouch';
+    static scriptName = 'orbitCameraInputTouch';
 
     /**
      * How fast the camera moves around the orbit. Higher is faster

packages/lib/src/scripts/shadow-catcher/index.js

@@ -1,11 +1,24 @@
 import { Script, Entity, Layer, StandardMaterial, BLEND_NORMAL, SHADOW_VSM16, SHADOWUPDATE_REALTIME, CHUNKAPI_2_1 } from 'playcanvas';
+import { warnOnce } from '../../utils/validation.ts';
 
 const endPS = `
     litArgs_opacity = mix(light0_shadowIntensity, 0.0, shadow0);
     gl_FragColor.rgb = vec3(0.0);
 `;
 
+/**
+ * @deprecated This script is deprecated and will be removed in the next major version.
+ * 
+ * Use {@link https://github.com/playcanvas/engine/tree/main/scripts/esm/shadow-catcher.mjs | ShadowCatcher} from `playcanvas` instead.
+ * 
+ * ```tsx
+ * import { ShadowCatcher } from "playcanvas/scripts/esm/shadow-catcher.mjs";
+ *
+ * export const MyScript = () => <Script script={ShadowCatcher} />;
+ * ```
+ */
 export class ShadowCatcher extends Script {
+    static scriptName = 'shadowCatcher';
     /**
      * The shadow distance of the shadow catcher light.
      * @type {number}
@@ -43,6 +56,8 @@ export class ShadowCatcher extends Script {
     light = null;
 
     initialize() {
+        warnOnce('This script is deprecated and will be removed in the next major version. Use the `ShadowCatcher` from `playcanvas` instead.');
+
         // create and add the shadow layer
         this.layer = new Layer({
             name: 'Shadow Layer'