hytopia 0.3.0-dev.2 → 0.3.0-dev.3

package/boilerplate/index.ts

@@ -26,8 +26,8 @@
 import {
   startServer,
   Audio,
-  GameServer,
   PlayerEntity,
+  PlayerEvent,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -65,14 +65,18 @@ startServer(world => {
   world.loadMap(worldMap);
 
   /**
-   * Handle player joining the game. The onPlayerJoin
-   * function is called when a new player connects to
+   * Handle player joining the game. The PlayerEvent.JOINED_WORLD
+   * event is emitted to the world when a new player connects to
    * the game. From here, we create a basic player
    * entity instance which automatically handles mapping
    * their inputs to control their in-game entity and
    * internally uses our player entity controller.
+   * 
+   * The HYTOPIA SDK is heavily driven by events, you
+   * can find documentation on how the event system works,
+   * here: https://dev.hytopia.com/sdk-guides/events
    */
-  world.onPlayerJoin = player => {
+  world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
     const playerEntity = new PlayerEntity({
       player,
       name: 'Player',
@@ -89,11 +93,11 @@ startServer(world => {
     world.chatManager.sendPlayerMessage(player, 'Press space to jump.');
     world.chatManager.sendPlayerMessage(player, 'Hold shift to sprint.');
     world.chatManager.sendPlayerMessage(player, 'Press \\ to enter or exit debug view.');
-  };
+  });
 
   /**
-   * Handle player leaving the game. The onPlayerLeave
-   * function is called when a player leaves the game.
+   * Handle player leaving the game. The PlayerEvent.LEFT_WORLD
+   * event is emitted to the world when a player leaves the game.
    * Because HYTOPIA is not opinionated on join and
    * leave game logic, we are responsible for cleaning
    * up the player and any entities associated with them
@@ -101,10 +105,14 @@ startServer(world => {
    * getting all the known PlayerEntity instances for
    * the player who left by using our world's EntityManager
    * instance.
+   * 
+   * The HYTOPIA SDK is heavily driven by events, you
+   * can find documentation on how the event system works,
+   * here: https://dev.hytopia.com/sdk-guides/events
    */
-  world.onPlayerLeave = player => {
+  world.on(PlayerEvent.LEFT_WORLD, ({ player }) => {
     world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => entity.despawn());
-  };
+  });
 
   /**
    * A silly little easter egg command. When a player types

package/docs/server.modelregistry.md

@@ -73,6 +73,44 @@ Description
 The global ModelRegistry instance as a singleton.
 
 
+</td></tr>
+<tr><td>
+
+[optimize](./server.modelregistry.optimize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to use optimized models when they are loaded.
+
+
+</td></tr>
+<tr><td>
+
+[optimizeEveryStart](./server.modelregistry.optimizeeverystart.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to always run model optimization on server start.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.modelregistry.optimize.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [optimize](./server.modelregistry.optimize.md)
+
+## ModelRegistry.optimize property
+
+Whether to use optimized models when they are loaded.
+
+**Signature:**
+
+```typescript
+optimize: boolean;
+```

package/docs/server.modelregistry.optimizeeverystart.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [optimizeEveryStart](./server.modelregistry.optimizeeverystart.md)
+
+## ModelRegistry.optimizeEveryStart property
+
+Whether to always run model optimization on server start.
+
+**Signature:**
+
+```typescript
+optimizeEveryStart: boolean;
+```

package/docs/server.playerui.md

@@ -48,25 +48,6 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[onData?](./server.playerui.ondata.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(playerUI: [PlayerUI](./server.playerui.md)<!-- -->, data: object) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A function that is called when the player's client UI sends data to the server.
-
-
-</td></tr>
-<tr><td>
-
 [player](./server.playerui.player.md)
 
 

package/docs/server.playeruievent.md

@@ -32,6 +32,20 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+DATA
+
+
+</td><td>
+
+`"PLAYER_UI.DATA"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 LOAD
 
 

package/docs/server.playeruieventpayloads._player_ui.data_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md) &gt; ["PLAYER\_UI.DATA"](./server.playeruieventpayloads._player_ui.data_.md)
+
+## PlayerUIEventPayloads."PLAYER\_UI.DATA" property
+
+Emitted when data is received by the server from the player's client UI.
+
+**Signature:**
+
+```typescript
+[PlayerUIEvent.DATA]: {
+        playerUI: PlayerUI;
+        data: Record<string, any>;
+    };
+```

package/docs/server.playeruieventpayloads._player_ui.send_data_.md

@@ -4,13 +4,13 @@
 
 ## PlayerUIEventPayloads."PLAYER\_UI.SEND\_DATA" property
 
-Emitted when the player's client UI sends data to the server.
+Emitted when data is sent from the server to the player's client UI.
 
 **Signature:**
 
 ```typescript
 [PlayerUIEvent.SEND_DATA]: {
         playerUI: PlayerUI;
-        data: object;
+        data: Record<string, any>;
     };
 ```

package/docs/server.playeruieventpayloads.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+["PLAYER\_UI.DATA"](./server.playeruieventpayloads._player_ui.data_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: Record&lt;string, any&gt;; }
+
+
+</td><td>
+
+Emitted when data is received by the server from the player's client UI.
+
+
+</td></tr>
+<tr><td>
+
 ["PLAYER\_UI.LOAD"](./server.playeruieventpayloads._player_ui.load_.md)
 
 
@@ -83,12 +102,12 @@ Emitted when the player's mouse pointer is locked or unlocked.
 
 </td><td>
 
-{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: object; }
+{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: Record&lt;string, any&gt;; }
 
 
 </td><td>
 
-Emitted when the player's client UI sends data to the server.
+Emitted when data is sent from the server to the player's client UI.
 
 
 </td></tr>

package/examples/custom-ui/index.ts

@@ -4,7 +4,7 @@ import {
   Player,
   PlayerEntity,
   PlayerEvent,
-  PlayerUI,
+  PlayerUIEvent,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -40,7 +40,8 @@ startServer(world => {
 
     // Handle data sent from player to server by client UI interactions we define. 
     // See the ui/index.html file for the UI code that sends the data.
-    player.ui.onData = (playerUI: PlayerUI, data: Record<string, any>) => {
+    player.ui.on(PlayerUIEvent.DATA, ({ playerUI, data }) => {
+      console.log('data', data);
       if (data.type === 'teleport') {
         const randomX = Math.random() * 40 - 20; // Random between -20 and 20
         const randomY = Math.random() * 13 + 2;  // Random between 2 and 15
@@ -48,7 +49,7 @@ startServer(world => {
 
         playerEntity.setPosition({ x: randomX, y: randomY, z: randomZ });
       }
-    };
+    });
   });
 
   world.on(PlayerEvent.LEFT_WORLD, ({ player }) => {

package/examples/payload-game/assets/models/.optimized/bullet/bullet-named-nodes.gltf

@@ -0,0 +1,308 @@
+{
+  "asset": {
+    "generator": "glTF-Transform v4.1.2",
+    "version": "2.0"
+  },
+  "accessors": [
+    {
+      "type": "SCALAR",
+      "componentType": 5123,
+      "count": 132,
+      "bufferView": 0,
+      "byteOffset": 0
+    },
+    {
+      "type": "SCALAR",
+      "componentType": 5123,
+      "count": 6,
+      "bufferView": 0,
+      "byteOffset": 264
+    },
+    {
+      "type": "VEC3",
+      "componentType": 5126,
+      "count": 96,
+      "max": [
+        0.0625,
+        0.78125,
+        0.0625
+      ],
+      "min": [
+        -0.0625,
+        -0.28125,
+        -0.0625
+      ],
+      "bufferView": 1,
+      "byteOffset": 0
+    },
+    {
+      "type": "VEC3",
+      "componentType": 5126,
+      "count": 96,
+      "bufferView": 1,
+      "byteOffset": 12
+    },
+    {
+      "type": "VEC2",
+      "componentType": 5126,
+      "count": 96,
+      "bufferView": 1,
+      "byteOffset": 24
+    },
+    {
+      "type": "VEC3",
+      "componentType": 5126,
+      "count": 4,
+      "max": [
+        0.25,
+        0,
+        0.25
+      ],
+      "min": [
+        -0.25,
+        0,
+        -0.25
+      ],
+      "bufferView": 2,
+      "byteOffset": 0
+    },
+    {
+      "type": "VEC3",
+      "componentType": 5126,
+      "count": 4,
+      "bufferView": 2,
+      "byteOffset": 12
+    },
+    {
+      "type": "VEC2",
+      "componentType": 5126,
+      "count": 4,
+      "bufferView": 2,
+      "byteOffset": 24
+    },
+    {
+      "type": "VEC3",
+      "componentType": 5126,
+      "count": 4,
+      "max": [
+        0.78125,
+        0,
+        0.28125
+      ],
+      "min": [
+        -0.78125,
+        0,
+        -0.28125
+      ],
+      "bufferView": 3,
+      "byteOffset": 0
+    },
+    {
+      "type": "VEC2",
+      "componentType": 5126,
+      "count": 4,
+      "bufferView": 3,
+      "byteOffset": 12
+    }
+  ],
+  "bufferViews": [
+    {
+      "buffer": 0,
+      "byteOffset": 0,
+      "byteLength": 276,
+      "target": 34963
+    },
+    {
+      "buffer": 0,
+      "byteOffset": 276,
+      "byteLength": 3072,
+      "byteStride": 32,
+      "target": 34962
+    },
+    {
+      "buffer": 0,
+      "byteOffset": 3348,
+      "byteLength": 128,
+      "byteStride": 32,
+      "target": 34962
+    },
+    {
+      "buffer": 0,
+      "byteOffset": 3476,
+      "byteLength": 80,
+      "byteStride": 20,
+      "target": 34962
+    }
+  ],
+  "samplers": [
+    {
+      "magFilter": 9728,
+      "minFilter": 9728,
+      "wrapS": 33071,
+      "wrapT": 33071
+    }
+  ],
+  "textures": [
+    {
+      "source": 0,
+      "sampler": 0
+    }
+  ],
+  "images": [
+    {
+      "mimeType": "image/png",
+      "uri": "baseColor.png"
+    }
+  ],
+  "buffers": [
+    {
+      "uri": "bullet-named-nodes.bin",
+      "byteLength": 3556
+    }
+  ],
+  "materials": [
+    {
+      "alphaMode": "MASK",
+      "alphaCutoff": 0.05,
+      "doubleSided": true,
+      "pbrMetallicRoughness": {
+        "metallicFactor": 0,
+        "baseColorTexture": {
+          "index": 0
+        }
+      }
+    }
+  ],
+  "meshes": [
+    {
+      "primitives": [
+        {
+          "attributes": {
+            "POSITION": 2,
+            "NORMAL": 3,
+            "TEXCOORD_0": 4
+          },
+          "mode": 4,
+          "material": 0,
+          "indices": 0
+        }
+      ]
+    },
+    {
+      "primitives": [
+        {
+          "attributes": {
+            "POSITION": 5,
+            "NORMAL": 6,
+            "TEXCOORD_0": 7
+          },
+          "mode": 4,
+          "material": 0,
+          "indices": 1
+        }
+      ]
+    },
+    {
+      "primitives": [
+        {
+          "attributes": {
+            "POSITION": 8,
+            "TEXCOORD_0": 9,
+            "NORMAL": 6
+          },
+          "mode": 4,
+          "material": 0,
+          "indices": 1
+        }
+      ]
+    },
+    {
+      "primitives": [
+        {
+          "attributes": {
+            "POSITION": 8,
+            "NORMAL": 6,
+            "TEXCOORD_0": 9
+          },
+          "mode": 4,
+          "material": 0,
+          "indices": 1
+        }
+      ]
+    }
+  ],
+  "nodes": [
+    {
+      "name": "beveled_cuboid",
+      "translation": [
+        0,
+        0.1875,
+        -0.25
+      ],
+      "rotation": [
+        0.7071067811865475,
+        0,
+        0,
+        0.7071067811865476
+      ],
+      "mesh": 0
+    },
+    {
+      "name": "plane",
+      "translation": [
+        0,
+        0.1875,
+        0
+      ],
+      "rotation": [
+        0.7071067811865475,
+        0,
+        0,
+        0.7071067811865476
+      ],
+      "mesh": 1
+    },
+    {
+      "name": "plane",
+      "translation": [
+        0,
+        0.1875,
+        0
+      ],
+      "rotation": [
+        0.5,
+        -0.4999999999999999,
+        0.5,
+        0.5000000000000001
+      ],
+      "mesh": 2
+    },
+    {
+      "name": "plane",
+      "translation": [
+        0,
+        0.1875,
+        0
+      ],
+      "rotation": [
+        0.7071067811865475,
+        5.551115123125786e-17,
+        0.7071067811865476,
+        1.6653345369377348e-16
+      ],
+      "mesh": 3
+    }
+  ],
+  "scenes": [
+    {
+      "name": "blockbench_export",
+      "nodes": [
+        0,
+        1,
+        2,
+        3
+      ]
+    }
+  ],
+  "scene": 0
+}