hytopia 0.5.4 → 0.5.5

package/examples/entity-animations/index.ts

@@ -0,0 +1,65 @@
+import {
+  startServer,
+  Entity,
+  PlayerEvent,
+  ModelRegistry,
+} from 'hytopia';
+
+import worldMap from './assets/map.json';
+
+startServer(world => {
+  world.loadMap(worldMap);
+
+  const animatedEntity = new Entity({
+    name: 'Entity',
+    modelUri: 'models/players/player.gltf', // Change the model here for testing different models
+    modelScale: 0.5, // Change the scale here relative to your neeeds.
+  })
+
+  animatedEntity.spawn(world, { x: 0, y: 10, z: 0 });
+
+
+  world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
+    // focus the camera on the animated entity.
+    player.camera.setAttachedToEntity(animatedEntity);
+
+    world.chatManager.sendPlayerMessage(player, 'Commands:');
+    world.chatManager.sendPlayerMessage(player, '/list - Show animations');
+    world.chatManager.sendPlayerMessage(player, '/loop <name> - Start looped animation');
+    world.chatManager.sendPlayerMessage(player, '/oneshot <name> - Start one-shot animation');
+    world.chatManager.sendPlayerMessage(player, '/stop <name> - Stop animation');
+    world.chatManager.sendPlayerMessage(player, '/stopall - Stop all animations');
+  });
+
+  world.on(PlayerEvent.LEFT_WORLD, ({ player }) => {
+    // Nothing to do, since we aren't spawning any player specific entities, etc.
+  });
+
+  world.chatManager.registerCommand('/list', player => {
+    const animationNames = ModelRegistry.instance.getAnimationNames(animatedEntity.modelUri!).join(', ');
+
+    world.chatManager.sendPlayerMessage(player, `Available animations: ${animationNames}`);
+  });
+
+  world.chatManager.registerCommand('/loop', (player, args) => {
+    world.chatManager.sendBroadcastMessage(`Looping ${args.join(' ')}`, '00FF00');
+    animatedEntity.startModelLoopedAnimations(args);
+  });
+
+  world.chatManager.registerCommand('/oneshot', (player, args) => {
+    world.chatManager.sendBroadcastMessage(`Oneshotting ${args.join(' ')}`, '00FF00');
+    animatedEntity.startModelOneshotAnimations(args);
+  });
+  
+  world.chatManager.registerCommand('/stop', (player, args) => {
+    world.chatManager.sendBroadcastMessage(`Stopped ${args.join(' ')}`, '00FF00');
+    animatedEntity.stopModelAnimations(args);
+  });
+  
+  world.chatManager.registerCommand('/stopall', player => {
+    world.chatManager.sendBroadcastMessage(`Stopped all animations`, '00FF00');
+    const animationNames = ModelRegistry.instance.getAnimationNames(animatedEntity.modelUri!)
+
+    animatedEntity.stopModelAnimations(animationNames);
+  });
+});

package/examples/entity-animations/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "entity-animations",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@hytopia.com/assets": "latest",
+    "hytopia": "latest"
+  },
+  "trustedDependencies": [
+    "mediasoup",
+    "sharp"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -25288,6 +25288,54 @@
           "name": "ModelRegistry",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ModelRegistry#getAnimationNames:member(1)",
+              "docComment": "/**\n * Retrieves an array of all known animation names for a model.\n *\n * @param modelUri - The URI of the model to retrieve the animation names for.\n *\n * @returns An array of all known animation names for the model.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getAnimationNames(modelUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "modelUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getAnimationNames"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!ModelRegistry#getBoundingBox:member(1)",

package/server.d.ts

@@ -3203,6 +3203,13 @@ export declare class ModelRegistry {
 
 
 
+    /**
+     * Retrieves an array of all known animation names for a model.
+     *
+     * @param modelUri - The URI of the model to retrieve the animation names for.
+     * @returns An array of all known animation names for the model.
+     */
+    getAnimationNames(modelUri: string): string[];
     /**
      * Retrieves the bounding box of a model.
      *