diff --git a/.changeset/large-carpets-post.md b/.changeset/large-carpets-post.md new file mode 100644 index 00000000..002e6645 --- /dev/null +++ b/.changeset/large-carpets-post.md @@ -0,0 +1,5 @@ +--- +"@playcanvas/react": patch +--- + +Adds a deprecation warning to OrbitControls diff --git a/packages/lib/src/components/Script.tsx b/packages/lib/src/components/Script.tsx index fda2d61b..547026f8 100644 --- a/packages/lib/src/components/Script.tsx +++ b/packages/lib/src/components/Script.tsx @@ -49,7 +49,9 @@ interface ScriptProps { [key: string]: unknown; } -class NullScript extends PcScript {} +class NullScript extends PcScript { + static scriptName = 'null-script'; +} const componentDefinition = { name: "Script", diff --git a/packages/lib/src/scripts/orbit-controls/index.tsx b/packages/lib/src/scripts/orbit-controls/index.tsx index bb688116..bac438fa 100644 --- a/packages/lib/src/scripts/orbit-controls/index.tsx +++ b/packages/lib/src/scripts/orbit-controls/index.tsx @@ -1,6 +1,7 @@ import { Entity, Vec3 } from "playcanvas"; import { Script } from "../../components/Script.tsx"; import { OrbitCamera, OrbitCameraInputMouse, OrbitCameraInputTouch } from "./orbit-camera.js"; +import { warnOnce } from "../../utils/validation.ts"; type OrbitCameraProps = { distanceMax?: number @@ -29,6 +30,8 @@ export const OrbitControls = ({ mouse = { orbitSensitivity: 0.3, distanceSensitivity: 0.15 }, touch = { orbitSensitivity: 0.4, distanceSensitivity: 0.2 }, } : OrbitControls) => { + + warnOnce('The `` component is deprecated and will be removed in a future release. Use the PlayCanvas `CameraControls` script from `playcanvas` via the `