feat: spring bones

package.json

@@ -9,7 +9,7 @@
     "@babylonjs/inspector": "^4.2.2",
     "@babylonjs/loaders": "^4.2.2",
     "@babylonjs/materials": "^4.2.2",
-    "@dcl/schemas": "^20.3.3",
+    "@dcl/schemas": "^26.0.0",
     "@dcl/ui-env": "^1.5.1",
     "@sentry/browser": "^10.42.0",
     "classnames": "^2.3.1",

src/components/UnityPreview/UnityPreview.tsx

@@ -121,19 +121,19 @@ const useUnityRenderer = (
 
       try {
         const emoteDefinition = config?.itemDefinition && isEmote(config.itemDefinition) ? config.itemDefinition : null
-        const { unity, scene, emote } = await render(
+        const { unity, ...previewController } = await render(
           refs.canvas.current,
           emoteDefinition,
           config?.socialEmote || undefined,
         )
         refs.unityInstance.current = unity
-        controller.current = { scene, emote }
+        controller.current = previewController
 
-        // Forward emote events as postMessages to the parent iframe
         // Store cleanup to avoid listener leaks on re-init
         if (emoteCleanupRef.current) {
           emoteCleanupRef.current()
         }
+        // Forward emote events as postMessages to the parent iframe
         emoteCleanupRef.current = handleEmoteEvents(controller.current!)
 
         // Unity instance is initialized; wait for Unity LOADED message to mark as loaded and notify parent

src/lib/babylon/render.ts

@@ -1,5 +1,13 @@
 import { Color4, Mesh, TransformNode, Color3 } from '@babylonjs/core'
-import { PreviewConfig, PreviewType, BodyShape, IPreviewController, IEmoteController } from '@dcl/schemas'
+import {
+  PreviewConfig,
+  PreviewType,
+  BodyShape,
+  IPreviewController,
+  IEmoteController,
+  IPhysicsController,
+  SpringBoneParams,
+} from '@dcl/schemas'
 import { captureException } from '../sentry'
 import { createInvalidEmoteController, isEmote } from '../emote'
 import { getBodyShape } from './body'
@@ -23,8 +31,13 @@ export async function render(canvas: HTMLCanvasElement, config: PreviewConfig):
     // setup the mappings for all the contents
     setupMappings(config)
 
-    // emote controller
     let emoteController: IEmoteController
+    const physicsController: IPhysicsController = {
+      // Noop. Spring bones are not supported in Babylon.
+      setSpringBonesParams(_itemHash: string, _params: Record<string, SpringBoneParams>): Promise<void> {
+        return Promise.resolve()
+      },
+    }
 
     // load all the wearables into the root scene
     const promises: Promise<void | Asset>[] = []
@@ -121,6 +134,7 @@ export async function render(canvas: HTMLCanvasElement, config: PreviewConfig):
     const controller: IPreviewController = {
       scene: sceneController,
       emote: emoteController,
+      physics: physicsController,
     }
     return controller
   } catch (error) {

src/lib/unity/messages.ts

@@ -26,6 +26,9 @@ export enum UnityMethod {
 
   // Query methods
   GET_ELEMENT_BOUNDS = 'GetElementBounds',
+
+  // Physics
+  SET_SPRING_BONES_PARAMS = 'SetSpringBonesParams',
 }
 
 // Property mapping to Unity JSBridge methods

src/lib/unity/physics.ts

@@ -0,0 +1,12 @@
+import { IPhysicsController, SpringBoneParams } from '@dcl/schemas'
+import { UnityMethod } from './messages'
+import { UnityInstance } from './render'
+
+export function createPhysicsController(instance: UnityInstance): IPhysicsController {
+  return {
+    setSpringBonesParams: async (itemHash: string, params: Record<string, SpringBoneParams>): Promise<void> => {
+      if (!instance) return
+      instance.SendMessage('JSBridge', UnityMethod.SET_SPRING_BONES_PARAMS, JSON.stringify({ itemHash, params }))
+    },
+  }
+}

src/lib/unity/render.ts

@@ -4,6 +4,7 @@ import { loadUnityInstance } from './loader'
 import { createSceneController } from './scene'
 import { createEmoteController } from './emote'
 import { captureException } from '../sentry'
+import { createPhysicsController } from './physics'
 
 export interface UnityInstance {
   SendMessage: (objectName: string, methodName: string, value: string) => void
@@ -83,10 +84,12 @@ export async function render(
 
     const sceneController = createSceneController(instance)
     const emoteController = createEmoteController(instance, emote, socialEmote)
+    const physicsController = createPhysicsController(instance)
 
     return {
       scene: sceneController,
       emote: emoteController,
+      physics: physicsController,
       unity: instance,
     }
   } catch (error) {