hytopia 0.1.33 → 0.1.36

package/server.d.ts

@@ -23,7 +23,7 @@ import { WebSocket as WebSocket_2 } from 'ws';
  * @example
  * ```typescript
  * (new Audio({
- *   uri: 'assets/music/song.mp3',
+ *   uri: 'music/song.mp3', // relative to the server's assets directory in the project root, resolves to assets/music/song.mp3
  *   loop: true,
  *   volume: 0.5,
  * })).play(world);
@@ -365,7 +365,7 @@ export declare class Block {
  * const stoneBlockTypeId = 10;
  * world.blockTypeRegistry.registerBlockType(stoneBlockTypeId, new BlockType({
  *   id: stoneBlockTypeId,
- *   textureUri: 'assets/textures/stone.png',
+ *   textureUri: 'textures/stone.png',
  *   name: 'Stone',
  * }));
  *
@@ -435,7 +435,7 @@ export declare interface BlockTypeOptions {
  * ```typescript
  * world.blockTypeRegistry.registerGenericBlockType({
  *   id: 15,
- *   textureUri: 'assets/textures/dirt.png',
+ *   textureUri: 'textures/dirt.png',
  *   name: 'Dirt',
  * });
  * ```
@@ -467,10 +467,9 @@ export declare class BlockTypeRegistry implements protocol.Serializable {
     registerGenericBlockType(blockTypeOptions: BlockTypeOptions): BlockType;
     /**
      * Register a block type.
-     * @param id - The id of the block type to register.
-     * @param blockTypeReference - The block type to register.
+     * @param blockType - The block type to register.
      */
-    registerBlockType(id: number, blockTypeReference: BlockType): void;
+    registerBlockType(blockType: BlockType): void;
 
 }
 
@@ -664,6 +663,18 @@ export declare class Chunk implements protocol.Serializable {
      * Despawn the chunk from the world.
      */
     despawn(): void;
+    /**
+     * Get the block type id at a specific local coordinate.
+     * @param localCoordinate - The local coordinate of the block to get.
+     * @returns The block type id.
+     */
+    getBlock(localCoordinate: Vector3): number;
+    /**
+     * Check if a block exists at a specific local coordinate.
+     * @param localCoordinate - The local coordinate of the block to check.
+     * @returns Whether a block exists.
+     */
+    hasBlock(localCoordinate: Vector3): boolean;
     /**
      * Set the block at a specific local coordinate by block type id.
      * @param localCoordinate - The local coordinate of the block to set.
@@ -721,6 +732,12 @@ export declare class ChunkLattice {
     constructor(world: World);
 
 
+    /**
+     * Get the block type id at a specific global coordinate.
+     * @param globalCoordinate - The global coordinate of the block to get.
+     * @returns The block type id, 0 if no block is set.
+     */
+    getBlock(globalCoordinate: Vector3): number;
     /**
      * Get a chunk by its origin coordinate.
      * @param originCoordinate - The origin coordinate of the chunk to get.
@@ -732,6 +749,12 @@ export declare class ChunkLattice {
      * @returns An array of all chunks in the lattice.
      */
     getAllChunks(): Chunk[];
+    /**
+     * Check if a block exists at a specific global coordinate.
+     * @param globalCoordinate - The global coordinate of the block to check.
+     * @returns Whether a block exists.
+     */
+    hasBlock(globalCoordinate: Vector3): boolean;
     /**
      * Check if a chunk exists by its origin coordinate.
      * @param originCoordinate - The origin coordinate of the chunk to check.
@@ -740,9 +763,9 @@ export declare class ChunkLattice {
     hasChunk(originCoordinate: Vector3): boolean;
     /**
      * Set the block at a global coordinate by block type id, automatically
-     * creating a chunk if it doesn't exist.
+     * creating a chunk if it doesn't exist. Use block type id 0 for air.
      * @param globalCoordinate - The global coordinate of the block to set.
-     * @param blockTypeId - The block type id to set.
+     * @param blockTypeId - The block type id to set. Use 0 to remove the block and replace with air.
      */
     setBlock(globalCoordinate: Vector3, blockTypeId: number): void;
 
@@ -769,6 +792,7 @@ export declare class Collider {
 
 
 
+
     /**
      * @param colliderOptions - The options for the collider instance.
      */
@@ -785,6 +809,8 @@ export declare class Collider {
     get parentRigidBody(): RigidBody | undefined;
     /** The raw collider object from the Rapier physics engine. */
     get rawCollider(): RAPIER.Collider | undefined;
+    /** The shape of the collider. */
+    get shape(): ColliderShape;
     /** An arbitrary identifier tag of the collider. Useful for your own logic. */
     get tag(): string | undefined;
     /**
@@ -1062,7 +1088,10 @@ export declare type DecodedCollisionGroups = {
     collidesWith: string[];
 };
 
-/** The default rigid body options when EntityOptions.rigidBodyOptions is not provided. @public */
+/** The default rigid body options for a block entity when EntityOptions.rigidBodyOptions is not provided. @public */
+export declare const DEFAULT_BLOCK_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions;
+
+/** The default rigid body options for a model entity when EntityOptions.rigidBodyOptions is not provided. @public */
 export declare const DEFAULT_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions;
 
 /**
@@ -1260,12 +1289,22 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
+
+
+
     /**
      * @param options - The options for the entity.
      */
     constructor(options: EntityOptions);
     /** The unique identifier for the entity. */
     get id(): number | undefined;
+    /** The character controller for the entity. */
+    get characterController(): BaseCharacterController | undefined;
+    /** The half extends of the visual size of the block entity when blockTextureUri is set. */
+    get blockHalfExtents(): Vector3 | undefined;
+    /** The URI or path to the texture to be used, if this is set, the entity is a block entity. */
+    get blockTextureUri(): string | undefined;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     get modelUri(): string | undefined;
     /** The looped animations to start when the entity is spawned. */
@@ -1274,8 +1313,10 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     get modelScale(): number | undefined;
     /** The name of the entity. */
     get name(): string;
-    /** The character controller for the entity. */
-    get characterController(): BaseCharacterController | undefined;
+    /** An arbitrary identifier tag of the entity. Useful for your own logic. */
+    get tag(): string | undefined;
+    /** The tint color of the entity. */
+    get tintColor(): RgbColor | undefined;
     /** Whether the entity is spawned. */
     get isSpawned(): boolean;
     /** The world the entity is in. */
@@ -1295,6 +1336,11 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param characterController - The character controller to set.
      */
     setCharacterController(characterController: BaseCharacterController): void;
+    /**
+     * Sets the tint color of the entity.
+     * @param tintColor - The tint color of the entity.
+     */
+    setTintColor(tintColor: RgbColor | undefined): void;
     /**
      * Starts looped animations for the entity, blending with
      * other animations currently playing.
@@ -1326,6 +1372,10 @@ export declare namespace EntityEventPayload {
     export interface Despawn {
         entity: Entity;
     }
+    export interface SetTintColor {
+        entity: Entity;
+        tintColor: RgbColor | undefined;
+    }
     export interface Spawn {
         entity: Entity;
     }
@@ -1354,8 +1404,9 @@ export declare namespace EntityEventPayload {
 /** Event types an Entity instance can emit. @public */
 export declare enum EntityEventType {
     DESPAWN = "ENTITY.DESPAWN",
+    SET_TINT_COLOR = "ENTITY.SET_TINT_COLOR",
     SPAWN = "ENTITY.SPAWN",
-    START_MODEL_LOOPED_ANIMATIONS = "ENTITY.UPDATE_MODEL_LOOPED_ANIMATIONS",
+    START_MODEL_LOOPED_ANIMATIONS = "ENTITY.START_MODEL_LOOPED_ANIMATIONS",
     START_MODEL_ONESHOT_ANIMATIONS = "ENTITY.START_MODEL_ONESHOT_ANIMATIONS",
     STOP_MODEL_ANIMATIONS = "ENTITY.STOP_MODEL_ANIMATIONS",
     UPDATE_ROTATION = "ENTITY.UPDATE_ROTATION",
@@ -1406,12 +1457,28 @@ export declare class EntityManager {
      * @returns The spawned entity with the provided id, or undefined if no entity is found.
      */
     getEntity<T extends Entity>(id: number): T | undefined;
+    /**
+     * Gets all spawned entities in the world with a specific tag.
+     * @param tag - The tag to get the entities for.
+     * @returns All spawned entities in the world with the provided tag.
+     */
+    getEntitiesByTag(tag: string): Entity[];
+    /**
+     * Gets all spawned entities in the world with a tag that includes a specific substring.
+     * @param tagSubstring - The tag substring to get the entities for.
+     * @returns All spawned entities in the world with a tag that includes the provided substring.
+     */
+    getEntitiesByTagSubstring(tagSubstring: string): Entity[];
 
 
 }
 
 /** Options for creating an Entity instance. @public */
 export declare interface EntityOptions {
+    /** The half extents of the visual size of the block entity when blockTextureUri is set. If no rigidBodyOptions.colliders are provided, a block collider with the size of the half extents will be created. */
+    blockHalfExtents?: Vector3;
+    /** The texture uri of a entity if the entity is a block entity, if set rigidBodyOptions collider shape [0] must be a block */
+    blockTextureUri?: string;
     /**
      * A function that creates a custom character controller for the entity when it spawns.
      * @param entity - The Entity instance.
@@ -1428,6 +1495,10 @@ export declare interface EntityOptions {
     name?: string;
     /** The rigid body options for the entity. */
     rigidBodyOptions?: RigidBodyOptions;
+    /** An arbitrary identifier tag of the entity. Useful for your own logic. */
+    tag?: string;
+    /** The tint color of the entity as a hex code. */
+    tintColor?: RgbColor;
 }
 
 /** An EventRouter event. @public */
@@ -1614,6 +1685,7 @@ declare namespace HYTOPIA {
         DefaultCharacterControllerOptions,
         Entity,
         EntityEventType,
+        DEFAULT_BLOCK_ENTITY_RIGID_BODY_OPTIONS,
         DEFAULT_ENTITY_RIGID_BODY_OPTIONS,
         EntityOptions,
         EntityEventPayload,
@@ -1624,6 +1696,7 @@ declare namespace HYTOPIA {
         GameServerEventType,
         startServer,
         GameServerEventPayload,
+        RgbColor,
         Rotation,
         SpdMatrix3,
         Vector3,
@@ -1653,7 +1726,6 @@ declare namespace HYTOPIA {
         MoveCompleteCallback,
         MoveOptions,
         Simulation,
-        WebServer,
         PORT,
         World,
         WorldMap,
@@ -2118,6 +2190,13 @@ declare type RayCastOptions = {
     filterPredicate?: (collider: RAPIER.Collider) => boolean;
 };
 
+/** A RGB color. @public */
+export declare interface RgbColor {
+    r: number;
+    g: number;
+    b: number;
+}
+
 /**
  * Represents a rigid body in a world's physics simulation.
  *
@@ -2138,7 +2217,6 @@ export declare class RigidBody {
 
 
 
-
     /**
      * @param options - The options for the rigid body instance.
      */
@@ -2171,8 +2249,6 @@ export declare class RigidBody {
     get numColliders(): number;
     /** The raw RAPIER rigid body instance. */
     get rawRigidBody(): RAPIER.RigidBody | undefined;
-    /** An arbitrary identifier tag of the rigid body. Useful for your own logic. */
-    get tag(): string | undefined;
     /**
      * Gets the additional mass of the rigid body.
      * @returns The additional mass of the rigid body.
@@ -2409,11 +2485,6 @@ export declare class RigidBody {
      * @param collisionGroups - The collision groups for solid colliders of the rigid body.
      */
     setCollisionGroupsForSolidColliders(collisionGroups: CollisionGroups): void;
-    /**
-     * Sets the tag of the rigid body.
-     * @param tag - The tag of the rigid body.
-     */
-    setTag(tag: string): void;
     /**
      * Sets the translation of the rigid body.
      * @param translation - The translation of the rigid body.
@@ -2558,8 +2629,6 @@ export declare interface RigidBodyOptions {
     sleeping?: boolean;
     /** The soft continuous collision detection prediction of the rigid body. */
     softCcdPrediction?: number;
-    /** The tag of the rigid body. */
-    tag?: string;
     /** The translation of the rigid body. */
     translation?: Vector3;
 }
@@ -2700,6 +2769,11 @@ export declare class Simulation {
     enableDebugRendering(enabled: boolean): void;
 
 
+    /**
+     * Sets the gravity vector for the simulation.
+     * @param gravity - The gravity vector.
+     */
+    setGravity(gravity: RAPIER.Vector3): void;
 
 
 
@@ -2740,33 +2814,6 @@ export declare interface Vector3Boolean {
     x: boolean;
     y: boolean;
     z: boolean;
-}
-
-/**
- * Manages the internal HTTP server for the game server.
- *
- * @remarks
- * This class is used as a singleton and should be
- * accessed via the GameServer.webServer property.
- *
- * @public
- */
-export declare class WebServer implements Readyable {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 }
 
 /**
@@ -2935,14 +2982,7 @@ export declare enum WorldLoopEventType {
 /** A map representation for a world. @public */
 export declare interface WorldMap {
     /** The block types in the map. */
-    blockTypes: {
-        /** The ID of the block type. */
-        id: number;
-        /** The name of the block type. */
-        name: string;
-        /** The URI of the texture for the block type. */
-        textureUri: string;
-    }[];
+    blockTypes: BlockTypeOptions[];
     /** The blocks in the map */
     blocks: {
         /** The global coordinate to block type id mapping. */