hytopia 0.3.11 → 0.3.13

package/docs/server.playerentityoptions.md

@@ -2,57 +2,16 @@
 
 [Home](./index.md) > [server](./server.md) > [PlayerEntityOptions](./server.playerentityoptions.md)
 
-## PlayerEntityOptions interface
+## PlayerEntityOptions type
 
 Options for creating a PlayerEntity instance.
 
 **Signature:**
 
 ```typescript
-export interface PlayerEntityOptions extends EntityOptions 
+export type PlayerEntityOptions = {
+    player: Player;
+} & EntityOptions;
 ```
-**Extends:** [EntityOptions](./server.entityoptions.md)
+**References:** [Player](./server.player.md)<!-- -->, [EntityOptions](./server.entityoptions.md)
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[player](./server.playerentityoptions.player.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Player](./server.player.md)
-
-
-</td><td>
-
-The player the player entity is assigned to.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.playerui.lockpointer.md

@@ -4,7 +4,7 @@
 
 ## PlayerUI.lockPointer() method
 
-Locks or unlocks the player's mouse pointer.
+Locks or unlocks the player's mouse pointer. If the pointer is unlocked with lockPointer(false), the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
 
 **Signature:**
 

package/docs/server.playerui.md

@@ -111,7 +111,7 @@ Loads client UI for the player.
 
 </td><td>
 
-Locks or unlocks the player's mouse pointer.
+Locks or unlocks the player's mouse pointer. If the pointer is unlocked with lockPointer(false), the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
 
 
 </td></tr>

package/examples/entity-spawn/index.ts

@@ -1,5 +1,7 @@
 import {
   startServer,
+  BlockType,
+  Collider,
   ColliderShape,
   Entity,
   EntityEvent,
@@ -7,7 +9,6 @@ import {
   PlayerEvent,
   RigidBodyType,
   World,
-  Collider,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -41,8 +42,8 @@ startServer(world => {
           radius: 9,
           isSensor: true, // Sensors are colliders that do not react with physics, but can still trigger collision events.
           tag: 'aggro-sensor',
-          onCollision: (otherEntity, started) => {
-            console.log('spider aggro-sensor colliding with', otherEntity.name, started);
+          onCollision: (other: Entity | BlockType, started: boolean) => {
+            console.log('spider aggro-sensor colliding with', other.name, started);
           },
         },
       ],

package/examples/hygrounds/classes/ChestEntity.ts

@@ -3,7 +3,7 @@ import {
   BallColliderOptions,
   Collider,
   Entity,
-  EntityOptions,
+  ModelEntityOptions,
   QuaternionLike,
   SceneUI,
   Vector3Like,
@@ -18,7 +18,7 @@ export default class ChestEntity extends Entity {
   private _openAudio: Audio;
   private _opened: boolean = false;
 
-  public constructor(options: EntityOptions = {}) {
+  public constructor(options: Partial<ModelEntityOptions> = {}) {
     super({
       modelUri: 'models/environment/chest.gltf',
       modelScale: 1,

package/examples/hygrounds/classes/GunEntity.ts

@@ -14,7 +14,7 @@ import type { ItemEntityOptions } from './ItemEntity';
 
 export type GunHand = 'left' | 'right' | 'both';
 
-export interface GunEntityOptions extends ItemEntityOptions {
+export type GunEntityOptions = {
   ammo: number;              // The amount of ammo in the clip.
   damage: number;            // The damage of the gun.
   fireRate: number;          // Bullets shot per second.
@@ -25,7 +25,7 @@ export interface GunEntityOptions extends ItemEntityOptions {
   reloadTimeMs: number;      // Seconds to reload.
   shootAudioUri: string;     // The audio played when shooting
   scopeZoom?: number;         // The zoom level when scoped in.
-}
+} & ItemEntityOptions;
 
 export default abstract class GunEntity extends ItemEntity {
   protected readonly damage: number;
@@ -44,7 +44,7 @@ export default abstract class GunEntity extends ItemEntity {
   private _shootAudio: Audio;
 
   public constructor(options: GunEntityOptions) {
-    if (!options.modelUri) {
+    if (!('modelUri' in options)) {
       throw new Error('GunEntity requires modelUri');
     }
 

package/examples/hygrounds/classes/ItemEntity.ts

@@ -4,11 +4,14 @@ import {
   CollisionGroup,
   Entity,
   EntityOptions,
+  BlockEntityOptions,
+  ModelEntityOptions,
   PlayerEntityController,
   QuaternionLike,
   SceneUI,
   Vector3Like,
   World,
+  ErrorHandler,
 } from 'hytopia';
 
 import GamePlayerEntity from './GamePlayerEntity';
@@ -18,7 +21,7 @@ const INVENTORIED_POSITION = { x: 0, y: -300, z: 0 };
 
 export type HeldHand = 'left' | 'right' | 'both';
 
-export interface ItemEntityOptions extends EntityOptions {
+export type ItemEntityOptions = {
   heldHand: HeldHand;    // The hand the item is held in.
   iconImageUri: string;  // The image uri of the weapon icon.
   idleAnimation: string; // The animation played when the player holding it is idle.
@@ -27,7 +30,7 @@ export interface ItemEntityOptions extends EntityOptions {
   consumable?: boolean;
   consumeAudioUri?: string;
   consumeTimeMs?: number;
-}
+} & EntityOptions;
 
 export default class ItemEntity extends Entity {
   public readonly consumable: boolean;
@@ -42,19 +45,20 @@ export default class ItemEntity extends Entity {
   private readonly _labelSceneUI: SceneUI;
 
   public constructor(options: ItemEntityOptions) {
-    if (!options.modelUri && !options.blockHalfExtents) {
-      throw new Error('ItemEntity requires either modelUri or blockHalfExtents');
-    }
-
-    const colliderOptions = options.modelUri
+    const colliderOptions = 'modelUri' in options && options.modelUri
       ? Collider.optionsFromModelUri(options.modelUri)
-      : Collider.optionsFromBlockHalfExtents(options.blockHalfExtents!);
+      : 'blockHalfExtents' in options && options.blockHalfExtents
+        ? Collider.optionsFromBlockHalfExtents(options.blockHalfExtents)
+        : undefined;
 
+    if (!colliderOptions) {
+      ErrorHandler.fatalError('ItemEntity.constructor(): Item must be a model or block entity!');
+    }
 
     super({
       ...options,
       parentNodeName: ItemEntity._getHandAnchorNode(options.heldHand),
-      rigidBodyOptions: ItemEntity._createRigidBodyOptions(colliderOptions, options.modelScale ?? 1),
+      rigidBodyOptions: ItemEntity._createRigidBodyOptions(colliderOptions, 'modelScale' in options ? options.modelScale ?? 1 : 1),
     });
 
     this.consumable = options.consumable ?? false;

package/examples/hygrounds/classes/MeleeWeaponEntity.ts

@@ -11,14 +11,14 @@ import ItemEntity from './ItemEntity';
 import TerrainDamageManager from './TerrainDamageManager';
 import type { ItemEntityOptions } from './ItemEntity';
 
-export interface MeleeWeaponEntityOptions extends ItemEntityOptions {
+export type MeleeWeaponEntityOptions = {
   damage: number;           // The damage dealt by the weapon
   attackRate: number;       // Attacks per second
   range: number;            // The range of the melee attack
   attackAudioUri: string;   // The audio played when attacking
   hitAudioUri: string;      // The audio played when hitting an entity or block
-  minesMaterials: boolean;     // Whether the weapon mines materials when it hits a block
-}
+  minesMaterials: boolean;  // Whether the weapon mines materials when it hits a block
+} & ItemEntityOptions;
 
 export default abstract class MeleeWeaponEntity extends ItemEntity {
   protected readonly damage: number;

package/examples/zombies-fps/classes/EnemyEntity.ts

@@ -1,9 +1,9 @@
 import {
   Audio,
   Entity,
-  EntityOptions,
   EntityEvent,
   EventPayloads,
+  ModelEntityOptions,
   PathfindingEntityController,
 } from 'hytopia';
 
@@ -14,7 +14,7 @@ import GamePlayerEntity from './GamePlayerEntity';
 const RETARGET_ACCUMULATOR_THRESHOLD_MS = 5000;
 const PATHFIND_ACCUMULATOR_THRESHOLD_MS = 3000;
 
-export interface EnemyEntityOptions extends EntityOptions {
+export interface EnemyEntityOptions extends ModelEntityOptions {
   damage: number;
   damageAudioUri?: string;
   health: number;

package/examples/zombies-fps/classes/GunEntity.ts

@@ -3,12 +3,12 @@ import {
   CollisionGroup,
   CollisionGroupsBuilder,
   Entity,
-  EntityOptions,
   PlayerEntity,
   Vector3Like,
   QuaternionLike,
   World,
   PlayerEntityController,
+  ModelEntityOptions,
 } from 'hytopia';
 
 import EnemyEntity from './EnemyEntity';
@@ -16,7 +16,7 @@ import type GamePlayerEntity from './GamePlayerEntity';
 
 export type GunHand = 'left' | 'right' | 'both';
 
-export interface GunEntityOptions extends EntityOptions {
+export type GunEntityOptions = {
   ammo: number;              // The amount of ammo in the clip.
   damage: number;            // The damage of the gun.
   fireRate: number;          // Bullets shot per second.
@@ -30,7 +30,7 @@ export interface GunEntityOptions extends EntityOptions {
   reloadTimeMs: number;      // Seconds to reload.
   shootAnimation: string;    // The animation played when the gun is shooting.
   shootAudioUri: string;     // The audio played when shooting
-}
+} & ModelEntityOptions;
 
 export default abstract class GunEntity extends Entity {
   public ammo: number;

package/package.json

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