hytopia 0.3.28 → 0.3.30

package/examples/hygrounds/gameConfig.ts

@@ -44,18 +44,18 @@ export const BLOCK_ID_MATERIALS: Record<string | number, number> = {
 
 export const BUILD_BLOCK_ID = 37; // stone
 
-export const CHEST_DROP_INTERVAL_MS = 15 * 1000; // 20 seconds
+export const CHEST_DROP_INTERVAL_MS = 15 * 1000; // 15 seconds
 
 export const CHEST_DROP_REGION_AABB = {
   min: { x: -45, y: 100, z: -45 },
   max: { x: 45, y: 100, z: 45 },
 };
 
-export const CHEST_SPAWNS_AT_START = 15;
+export const CHEST_SPAWNS_AT_START = 20;
 
 export const CHEST_MAX_DROP_ITEMS = 2;
 
-export const CHEST_OPEN_DESPAWN_MS = 20 * 1000; // 20 seconds
+export const CHEST_OPEN_DESPAWN_MS = 10 * 1000; // 10 seconds
 
 export const CHEST_DROP_ITEMS = [
   {
@@ -92,7 +92,7 @@ export const CHEST_DROP_ITEMS = [
   },
   {
     itemId: 'pistol',
-    pickWeight: 1.5,
+    pickWeight: 0.8,
   },
   {
     itemId: 'revolver',
@@ -339,9 +339,9 @@ export const CHEST_SPAWNS = [
   },
 ];
 
-export const GAME_DURATION_MS = 10 * 60 * 1000; // 10 minutes
+export const GAME_DURATION_MS = 8 * 60 * 1000; // 8 minutes
 
-export const ITEM_DESPAWN_TIME_MS = 30 * 1000; // 30 seconds
+export const ITEM_DESPAWN_TIME_MS = 25 * 1000; // 25 seconds
 
 export const ITEM_SPAWNS = [
   { position: { x: -21.5, y: 2, z: -17 } },
@@ -364,66 +364,326 @@ export const ITEM_SPAWNS = [
 export const ITEM_SPAWN_ITEMS = [
   {
     itemId: 'ak47',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'auto-shotgun',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'auto-sniper',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'bolt-action-sniper',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'gravity-potion',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'light-machine-gun',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'medpack',
-    pickWeight: 1,
+    pickWeight: 0.5,
   },
   {
     itemId: 'mining-drill',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
   {
     itemId: 'pistol',
-    pickWeight: 1,
+    pickWeight: 0.3,
   },
   {
     itemId: 'revolver',
-    pickWeight: 0.1,
+    pickWeight: 0.5,
   },
   {
     itemId: 'rocket-launcher',
-    pickWeight: 0.03,
+    pickWeight: 0.3,
   },
   {
     itemId: 'shotgun',
-    pickWeight: 0.08,
+    pickWeight: 0.8,
   },
   {
     itemId: 'shield-potion',
-    pickWeight: 1,
+    pickWeight: 0.5,
   },
   {
     itemId: 'submachine-gun',
-    pickWeight: 0.05,
+    pickWeight: 0.5,
   },
 ];
 
-export const ITEM_SPAWNS_AT_START = 8;
+export const ITEM_SPAWNS_AT_START = 12;
 
 export const MINIMUM_PLAYERS_TO_START = 2;
 
+export const RANK_ASSIST_EXP = 20;
+export const RANK_SAVE_INTERVAL_EXP = 500; // Every increment of this, save the persisted data.
+export const RANK_KILL_EXP = 100;
+export const RANK_WIN_EXP = 1000;
+export const RANKS = [
+  {
+    name: 'Unranked',
+    totalExp: 0,
+    iconUri: 'icons/ranks/unranked.png',
+    unlocks: [],
+  },
+  {
+    name: 'Bronze I',
+    totalExp: 500,
+    iconUri: 'icons/ranks/bronze-1.png',
+    unlocks: [
+      'Visible Rank & Medal - Your rank and medal will be visible to all players in game above your head.',
+      'Bronze I Rank',
+    ]
+  },
+  {
+    name: 'Bronze II',
+    totalExp: 1000,
+    iconUri: 'icons/ranks/bronze-2.png',
+    unlocks: [
+      'Bronze II Rank',
+    ]
+  },
+  {
+    name: 'Bronze III',
+    totalExp: 1500,
+    iconUri: 'icons/ranks/bronze-3.png',
+    unlocks: [
+      'Bronze III Rank',
+    ]
+  },
+  {
+    name: 'Bronze IV',
+    totalExp: 2500,
+    iconUri: 'icons/ranks/bronze-4.png',
+    unlocks: [
+      'Bronze IV Rank',
+    ]
+  },
+  {
+    name: 'Bronze V',
+    totalExp: 4000,
+    iconUri: 'icons/ranks/bronze-5.png',
+    unlocks: [
+      'Bronze V Rank',
+    ]
+  },
+  {
+    name: 'Silver I',
+    totalExp: 6000,
+    iconUri: 'icons/ranks/silver-1.png',
+    unlocks: [
+      'Competitive Matches - Your performance in any match that includes other Silver rank or higher players will affect your competitive ranking based on your relative finishing position.',
+      'Silver I Rank',
+    ]
+  },
+  {
+    name: 'Silver II',
+    totalExp: 9000,
+    iconUri: 'icons/ranks/silver-2.png',
+    unlocks: [
+      'Silver II Rank',
+    ]
+  },
+  {
+    name: 'Silver III',
+    totalExp: 13000,
+    iconUri: 'icons/ranks/silver-3.png',
+    unlocks: [
+      'Silver III Rank',
+    ]
+  },
+  {
+    name: 'Silver IV',
+    totalExp: 18000,
+    iconUri: 'icons/ranks/silver-4.png',
+    unlocks: [
+      'Silver IV Rank',
+    ]
+  },
+  {
+    name: 'Silver V',
+    totalExp: 24000,
+    iconUri: 'icons/ranks/silver-5.png',
+    unlocks: [
+      'Silver V Rank',
+    ]
+  },
+  {
+    name: 'Gold I',
+    totalExp: 32000,
+    iconUri: 'icons/ranks/gold-1.png',
+    unlocks: [
+      'Gold Flex - All weapons will be tinted gold when you hold them.',
+      'Gold I Rank',
+    ]
+  },
+  {
+    name: 'Gold II',
+    totalExp: 42000,
+    iconUri: 'icons/ranks/gold-2.png',
+    unlocks: [
+      'Gold II Rank',
+    ]
+  },
+  {
+    name: 'Gold III',
+    totalExp: 54000,
+    iconUri: 'icons/ranks/gold-3.png',
+    unlocks: [
+      'Gold III Rank',
+    ]
+  },
+  {
+    name: 'Gold IV',
+    totalExp: 68000,
+    iconUri: 'icons/ranks/gold-4.png',
+    unlocks: [
+      'Gold IV Rank',
+    ]
+  },
+  {
+    name: 'Gold V',
+    totalExp: 85000,
+    iconUri: 'icons/ranks/gold-5.png',
+    unlocks: [
+      'Gold V Rank',
+    ]
+  },
+  {
+    name: 'Platinum I',
+    totalExp: 105000,
+    iconUri: 'icons/ranks/platinum-1.png',
+    unlocks: [
+      'Celestial Hammer - Your pickaxe is replaced with a magnificent celestial hammer.',
+      'Platinum I Rank',
+    ]
+  },
+  {
+    name: 'Platinum II',
+    totalExp: 130000,
+    iconUri: 'icons/ranks/platinum-2.png',
+    unlocks: [
+      'Platinum II Rank',
+    ]
+  },
+  {
+    name: 'Platinum III',
+    totalExp: 160000,
+    iconUri: 'icons/ranks/platinum-3.png',
+    unlocks: [
+      'Platinum III Rank',
+    ]
+  },
+  {
+    name: 'Platinum IV',
+    totalExp: 195000,
+    iconUri: 'icons/ranks/platinum-4.png',
+    unlocks: [
+      'Platinum IV Rank',
+    ]
+  },
+  {
+    name: 'Platinum V',
+    totalExp: 235000,
+    iconUri: 'icons/ranks/platinum-5.png',
+    unlocks: [
+      'Platinum V Rank',
+    ]
+  },
+  {
+    name: 'Diamond I',
+    totalExp: 280000,
+    iconUri: 'icons/ranks/diamond-1.png',
+    unlocks: [
+      'Opulent Wings - Your character will be adorned with visual wings.',
+      'Diamond I Rank',
+    ]
+  },
+  {
+    name: 'Diamond II',
+    totalExp: 330000,
+    iconUri: 'icons/ranks/diamond-2.png',
+    unlocks: [
+      'Diamond II Rank',
+    ]
+  },
+  {
+    name: 'Diamond III',
+    totalExp: 385000,
+    iconUri: 'icons/ranks/diamond-3.png',
+    unlocks: [
+      'Diamond III Rank',
+    ]
+  },
+  {
+    name: 'Diamond IV',
+    totalExp: 445000,
+    iconUri: 'icons/ranks/diamond-4.png',
+    unlocks: [
+      'Diamond IV Rank',
+    ]
+  },
+  {
+    name: 'Diamond V',
+    totalExp: 510000,
+    iconUri: 'icons/ranks/diamond-5.png',
+    unlocks: [
+      'Diamond V Rank',
+    ]
+  },
+  {
+    name: 'Elite I',
+    totalExp: 580000,
+    iconUri: 'icons/ranks/elite-1.png',
+    unlocks: [
+      'Elite Outfit - Your character will be adorned with a special elite outfit.',
+      'Elite I Rank',
+    ]
+  },
+  {
+    name: 'Elite II',
+    totalExp: 655000,
+    iconUri: 'icons/ranks/elite-2.png',
+    unlocks: [
+      'Elite II Rank',
+    ]
+  },
+  {
+    name: 'Elite III',
+    totalExp: 735000,
+    iconUri: 'icons/ranks/elite-3.png',
+    unlocks: [
+      'Elite III Rank',
+    ]
+  },
+  {
+    name: 'Elite IV',
+    totalExp: 820000,
+    iconUri: 'icons/ranks/elite-4.png',
+    unlocks: [
+      'Elite IV Rank',
+    ]
+  },
+  {
+    name: 'Elite V',
+    totalExp: 910000,
+    iconUri: 'icons/ranks/elite-5.png',
+    unlocks: [
+      'Highest Honor - Your character will receive something extremely special. You will need to reach this rank to find out what it is!',
+      'Elite V Rank',
+    ]
+  },
+]
+
 export const SPAWN_REGION_AABB = {
   min: { x: -45, y: 30, z: -45 },
   max: { x: 45, y: 35, z: 45 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.3.28",
+  "version": "0.3.30",
   "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

@@ -275,6 +275,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Audio#cutoffDistance:member",
+              "docComment": "/**\n * The cutoff distance where the audio will be reduced to 0 volume.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get cutoffDistance(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cutoffDistance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Audio#detune:member",
@@ -717,7 +747,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -785,6 +815,54 @@
               "isAbstract": false,
               "name": "setAttachedToEntity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Audio#setCutoffDistance:member(1)",
+              "docComment": "/**\n * Sets the cutoff distance of the audio.\n *\n * @remarks\n *\n * The cutoff distance defines the maximum range at which the audio can be heard. Beyond this distance, the audio volume becomes zero. As the listener moves from the reference distance toward the cutoff distance, the volume decreases linearly, providing a natural spatial audio experience with smooth volume falloff based on distance.\n *\n * @param cutoffDistance - The cutoff distance.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setCutoffDistance(cutoffDistance: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "cutoffDistance",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setCutoffDistance"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Audio#setDetune:member(1)",
@@ -981,7 +1059,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Audio#setReferenceDistance:member(1)",
-              "docComment": "/**\n * Sets the reference distance of the audio.\n *\n * @param referenceDistance - The reference distance.\n */\n",
+              "docComment": "/**\n * Sets the reference distance of the audio.\n *\n * @remarks\n *\n * The reference distance defines the range within which the audio plays at full volume. When a listener is within this distance from the audio source, they will hear the sound at its maximum volume. Beyond this distance, the volume decreases linearly until reaching the cutoff distance, where the sound becomes inaudible. This creates a natural spatial audio experience with smooth volume falloff based on distance.\n *\n * @param referenceDistance - The reference distance.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1310,6 +1388,27 @@
               "releaseTag": "Public",
               "name": "SET_ATTACHED_TO_ENTITY"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!AudioEvent.SET_CUTOFF_DISTANCE:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_CUTOFF_DISTANCE = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"AUDIO.SET_CUTOFF_DISTANCE\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_CUTOFF_DISTANCE"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!AudioEvent.SET_DETUNE:member",
@@ -1642,6 +1741,51 @@
                 "endIndex": 8
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!AudioEventPayloads#\"AUDIO.SET_CUTOFF_DISTANCE\":member",
+              "docComment": "/**\n * Emitted when the audio's cutoff distance is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AudioEvent.SET_CUTOFF_DISTANCE",
+                  "canonicalReference": "server!AudioEvent.SET_CUTOFF_DISTANCE:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        audio: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Audio",
+                  "canonicalReference": "server!Audio:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        cutoffDistance: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"AUDIO.SET_CUTOFF_DISTANCE\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!AudioEventPayloads#\"AUDIO.SET_DETUNE\":member",
@@ -2277,6 +2421,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!AudioOptions#cutoffDistance:member",
+              "docComment": "/**\n * The cutoff distance between the audio source and the listener where the audio will be reduced to 0 volume. Must be greater than reference distance. Defaults to reference distance + 10.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "cutoffDistance?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "cutoffDistance",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!AudioOptions#detune:member",
@@ -2470,7 +2641,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!AudioOptions#referenceDistance:member",
-              "docComment": "/**\n * The reference distance for reducing volume as the audio source moves away from the listener.\n */\n",
+              "docComment": "/**\n * The maximum reference distance between the audio source and the listener where the audio will still be max volume. Defaults to 10.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -27262,7 +27433,7 @@
         {
           "kind": "Class",
           "canonicalReference": "server!PlayerEntity:class",
-          "docComment": "/**\n * Represents an entity controlled by a player in a world.\n *\n * @remarks\n *\n * Player entities extend the {@link Entity} class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated entity controller of the entity, calling the entity controller's onTickPlayerMovement method when player input has changed.\n *\n * @example\n * ```typescript\n * world.onPlayerJoin = player => {\n *   const playerEntity = new PlayerEntity({\n *     player,\n *     name: 'Player',\n *     modelUri: 'models/player-with-gun.gltf',\n *     modelLoopedAnimations: [ 'idle' ],\n *     modelScale: 0.5,\n *   });\n *\n *   playerEntity.spawn(world, { x: 10, y: 20, z: 15 });\n * };\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Represents an entity controlled by a player in a world.\n *\n * @remarks\n *\n * Player entities extend the {@link Entity} class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated entity controller of the entity, calling the entity controller's onTickPlayerMovement method when player input has changed.\n *\n * @example\n * ```typescript\n * world.onPlayerJoin = player => {\n *   const playerEntity = new PlayerEntity({\n *     player,\n *     name: 'Player',\n *     modelUri: 'models/players/player.gltf',\n *     modelLoopedAnimations: [ 'idle_lower', 'idle_upper' ],\n *     modelScale: 0.5,\n *   });\n *\n *   playerEntity.spawn(world, { x: 10, y: 20, z: 15 });\n * };\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",