hytopia 0.1.37 → 0.1.40

package/server.d.ts

@@ -308,11 +308,11 @@ export declare abstract class BaseCharacterController {
      */
     constructor(entity: Entity, _options?: Record<string, unknown>);
     /**
-     * Override this method to create sensor colliders
+     * Override this method to create controller specific colliders
      * to be attached to the controlled entity when it spawns.
      * @returns An array of colliders.
      */
-    createSensorColliders(): Collider[];
+    createColliders(): Collider[];
     /**
      * Override this method to handle entity movements
      * based on player input for your character controller.
@@ -377,13 +377,25 @@ export declare class Block {
 export declare class BlockType implements protocol.Serializable {
     /**
      * A callback function that is invoked when an entity collides with blocks of this type.
+     *
+     * @remarks
+     * This must be set before a block of this type is created.
+     * If it is set after a block is created, only future created
+     * blocks of this type will have the callback set.
+     *
      * @param blockType - The block type the collision is for.
      * @param entity - The entity that collided with the block type.
      * @param started - Whether the collision started.
      */
-    onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
+    onEntityCollision?: ((blockType: BlockType, entity: Entity, started: boolean) => void) | ((blockType: BlockType, entity: Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
     /**
      * A callback function that is invoked when an entity contacts a block of this type.
+     *
+     * @remarks
+     * This must be set before a block of this type is created.
+     * If it is set after a block is created, only future created
+     * blocks of this type will have the callback set.
+     *
      * @param blockType - The block type the contact is for.
      * @param entity - The entity that contacted the block type.
      * @param contactForceData - The contact force data.
@@ -682,7 +694,7 @@ export declare class Chunk implements protocol.Serializable {
     setBlock(localCoordinate: Vector3Like, blockTypeId: number): void;
 
 
-
+    private _meshColliders;
 
 
 
@@ -771,6 +783,14 @@ export declare class ChunkLattice {
 
 }
 
+/** The coefficient for friction or bounciness combine rule. @public */
+export declare enum CoefficientCombineRule {
+    Average = 0,
+    Min = 1,
+    Multiply = 2,
+    Max = 3
+}
+
 /**
  * Represents a collider in a world's physics simulation.
  *
@@ -817,6 +837,11 @@ export declare class Collider {
      * @returns The bounciness of the collider.
      */
     getBounciness(): number;
+    /**
+     * Gets the bounciness combine rule of the collider.
+     * @returns The bounciness combine rule of the collider.
+     */
+    getBouncinessCombineRule(): CoefficientCombineRule;
     /**
      * Gets the collision groups the collider belongs to.
      * @returns The collision groups the collider belongs to.
@@ -827,6 +852,11 @@ export declare class Collider {
      * @returns The friction of the collider.
      */
     getFriction(): number;
+    /**
+     * Gets the friction combine rule of the collider.
+     * @returns The friction combine rule of the collider.
+     */
+    getFrictionCombineRule(): CoefficientCombineRule;
     /**
      * Gets the relative rotation of the collider.
      * @returns The relative rotation of the collider.
@@ -843,10 +873,10 @@ export declare class Collider {
      */
     setBounciness(bounciness: number): void;
     /**
-     * Sets the on collision callback for the collider.
-     * @param callback - The on collision callback for the collider.
+     * Sets the bounciness combine rule of the collider.
+     * @param bouncinessCombineRule - The bounciness combine rule of the collider.
      */
-    setOnCollision(callback: CollisionCallback | undefined): void;
+    setBouncinessCombineRule(bouncinessCombineRule: CoefficientCombineRule): void;
     /**
      * Sets the collision groups of the collider.
      * @param collisionGroups - The collision groups of the collider.
@@ -862,11 +892,21 @@ export declare class Collider {
      * @param friction - The friction of the collider.
      */
     setFriction(friction: number): void;
+    /**
+     * Sets the friction combine rule of the collider.
+     * @param frictionCombineRule - The friction combine rule of the collider.
+     */
+    setFrictionCombineRule(frictionCombineRule: CoefficientCombineRule): void;
     /**
      * Sets the mass of the collider.
      * @param mass - The mass of the collider.
      */
     setMass(mass: number): void;
+    /**
+     * Sets the on collision callback for the collider.
+     * @param callback - The on collision callback for the collider.
+     */
+    setOnCollision(callback: CollisionCallback | undefined): void;
     /**
      * Sets the relative rotation of the collider.
      * @param rotation - The relative rotation of the collider.
@@ -924,16 +964,22 @@ export declare interface ColliderOptions {
     borderRadius?: number;
     /** The bounciness of the collider. */
     bounciness?: number;
+    /** The bounciness combine rule of the collider. */
+    bouncinessCombineRule?: CoefficientCombineRule;
     /** The collision groups the collider belongs to. */
     collisionGroups?: CollisionGroups;
     /** Whether the collider is enabled. */
     enabled?: boolean;
     /** The friction of the collider. */
     friction?: number;
+    /** The friction combine rule of the collider. */
+    frictionCombineRule?: CoefficientCombineRule;
     /** The half extents of the collider if the shape is a block. */
     halfExtents?: Vector3Like;
     /** The half height of the collider if the shape is a capsule, cone, cylinder, or round cylinder. */
     halfHeight?: number;
+    /** The indices of the collider if the shape is a trimesh. */
+    indices?: Uint32Array;
     /** Whether the collider is a sensor. */
     isSensor?: boolean;
     /** The mass of the collider. */
@@ -952,6 +998,8 @@ export declare interface ColliderOptions {
     simulation?: Simulation;
     /** An arbitrary identifier tag of the collider. Useful for your own logic. */
     tag?: string;
+    /** The vertices of the collider if the shape is a trimesh. */
+    vertices?: Float32Array;
 }
 
 /** The shapes a collider can be. @public */
@@ -961,7 +1009,8 @@ export declare enum ColliderShape {
     CAPSULE = "capsule",
     CONE = "cone",
     CYLINDER = "cylinder",
-    ROUND_CYLINDER = "round-cylinder"
+    ROUND_CYLINDER = "round-cylinder",
+    TRIMESH = "trimesh"
 }
 
 /**
@@ -970,7 +1019,7 @@ export declare enum ColliderShape {
  * @param started - Whether the collision has started or ended.
  * @public
  */
-export declare type CollisionCallback = (other: BlockType | Entity, started: boolean) => void;
+export declare type CollisionCallback = ((other: BlockType | Entity, started: boolean) => void) | ((other: BlockType | Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
 
 /**
  * The default collision groups.
@@ -1081,6 +1130,16 @@ declare type ContactForceData = {
     maxForceMagnitude: number;
 };
 
+/** A contact manifold. @public */
+declare type ContactManifold = {
+    /** The local normal vector of the first collider. */
+    localNormalA: Vector3Like;
+    /** The local normal vector of the second collider. */
+    localNormalB: Vector3Like;
+    /** The normal vector of the contact. */
+    normal: Vector3Like;
+};
+
 /** A decoded set of collision groups represented as their string equivalents. @public */
 export declare type DecodedCollisionGroups = {
     belongsTo: string[];
@@ -1161,11 +1220,11 @@ export declare class DefaultCharacterController extends BaseCharacterController
     /** The platform the entity is on, if any. */
     get platform(): Entity | undefined;
     /**
-     * Creates the sensor colliders for the character controller,
+     * Creates the colliders for the character controller,
      * overriding the default implementation.
      * @returns An array of colliders.
      */
-    createSensorColliders(): Collider[];
+    createColliders(): Collider[];
     /**
      * Ticks the player movement for the character controller,
      * overriding the default implementation.
@@ -1236,13 +1295,21 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
     /**
      * A function that is called when the entity collides with a block.
+     *
+     * @remarks
+     * This must be set before the entity is spawned.
+     *
      * @param entity - The Entity instance the collision is for.
      * @param blockType - The block type that the entity collided with.
      * @param started - Whether the collision started or ended.
      */
-    onBlockCollision?: (entity: Entity, blockType: BlockType, started: boolean) => void;
+    onBlockCollision?: ((entity: Entity, blockType: BlockType, started: boolean) => void) | ((entity: Entity, blockType: BlockType, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
     /**
      * A function that is called when the entity collides with a block.
+     *
+     * @remarks
+     * This must be set before the entity is spawned.
+     *
      * @param entity - The Entity instance the collision is for.
      * @param blockType - The block type that the entity collided with.
      * @param contactForceData - The contact force data.
@@ -1250,13 +1317,21 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     onBlockContactForce?: (entity: Entity, blockType: BlockType, contactForceData: ContactForceData) => void;
     /**
      * A function that is called when the entity collides with another entity.
+     *
+     * @remarks
+     * This must be set before the entity is spawned.
+     *
      * @param entity - The Entity instance the collision is for.
      * @param otherEntity - The other entity that the entity collided with.
      * @param started - Whether the collision started or ended.
      */
-    onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
+    onEntityCollision?: ((entity: Entity, otherEntity: Entity, started: boolean) => void) | ((entity: Entity, otherEntity: Entity, started: boolean, colliderHandleA: number, colliderHandleB: number) => void);
     /**
      * A function that is called when the entity contacts another entity.
+     *
+     * @remarks
+     * This must be set before the entity is spawned.
+     *
      * @param entity - The Entity instance the collision is for.
      * @param otherEntity - The other entity that the entity collided with.
      * @param contactForceData - The contact force data.
@@ -1292,6 +1367,7 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
     /**
      * @param options - The options for the entity.
      */
@@ -1306,6 +1382,8 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     get blockTextureUri(): string | undefined;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     get modelUri(): string | undefined;
+    /** The nodes to hide on the entity's model. */
+    get modelHiddenNodes(): ReadonlySet<string>;
     /** The looped animations to start when the entity is spawned. */
     get modelLoopedAnimations(): ReadonlySet<string>;
     /** The scale of the entity's model. */
@@ -1316,6 +1394,10 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     get tag(): string | undefined;
     /** The tint color of the entity. */
     get tintColor(): RgbColor | undefined;
+    /** Whether the entity is a block entity. */
+    get isBlockEntity(): boolean;
+    /** Whether the entity is a model entity. */
+    get isModelEntity(): boolean;
     /** Whether the entity is spawned. */
     get isSpawned(): boolean;
     /** The world the entity is in. */
@@ -1335,6 +1417,13 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param characterController - The character controller to set.
      */
     setCharacterController(characterController: BaseCharacterController): void;
+    /**
+     * Sets the nodes to hide on the entity's model. Matched nodes
+     * will be hidden for all players. Uses case insensitive
+     * substring matching.
+     * @param modelHiddenNodes - The nodes to hide on the entity's model.
+     */
+    setModelHiddenNodes(modelHiddenNodes: string[]): void;
     /**
      * Sets the tint color of the entity.
      * @param tintColor - The tint color of the entity.
@@ -1343,17 +1432,32 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     /**
      * Starts looped animations for the entity, blending with
      * other animations currently playing.
+     *
+     * @remarks
+     * This method will be ignored and do nothing if the entity
+     * is a block entity.
+     *
      * @param animations - The animations to start.
      */
     startModelLoopedAnimations(animations: string[]): void;
     /**
      * Starts a oneshot animation for the entity, blending with
      * other animations currently playing.
+     *
+     * @remarks
+     * This method will be ignored and do nothing if the entity
+     * is a block entity.
+     *
      * @param animations - The animations to start.
      */
     startModelOneshotAnimations(animations: string[]): void;
     /**
      * Stops the provided model animations for the entity.
+     *
+     * @remarks
+     * This method will be ignored and do nothing if the entity
+     * is a block entity.
+     *
      * @param animations - The animations to stop.
      */
     stopModelAnimations(animations: string[]): void;
@@ -1363,7 +1467,6 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
-
 }
 
 /** Payloads for events an Entity instance can emit. @public */
@@ -1371,6 +1474,10 @@ export declare namespace EntityEventPayload {
     export interface Despawn {
         entity: Entity;
     }
+    export interface SetModelHiddenNodes {
+        entity: Entity;
+        modelHiddenNodes: Set<string>;
+    }
     export interface SetTintColor {
         entity: Entity;
         tintColor: RgbColor | undefined;
@@ -1403,6 +1510,7 @@ export declare namespace EntityEventPayload {
 /** Event types an Entity instance can emit. @public */
 export declare enum EntityEventType {
     DESPAWN = "ENTITY.DESPAWN",
+    SET_MODEL_HIDDEN_NODES = "ENTITY.SET_MODEL_HIDDEN_NODES",
     SET_TINT_COLOR = "ENTITY.SET_TINT_COLOR",
     SPAWN = "ENTITY.SPAWN",
     START_MODEL_LOOPED_ANIMATIONS = "ENTITY.START_MODEL_LOOPED_ANIMATIONS",
@@ -1486,6 +1594,8 @@ export declare interface EntityOptions {
     createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     modelUri?: string;
+    /** The nodes to hide on the entity's model. */
+    modelHiddenNodes?: string[];
     /** The looped animations to start when the entity is spawned. */
     modelLoopedAnimations?: string[];
     /** The scale of the entity's model. */
@@ -1672,6 +1782,7 @@ declare namespace HYTOPIA {
         ChunkEventPayload,
         ChunkLattice,
         Collider,
+        CoefficientCombineRule,
         ColliderShape,
         ColliderOptions,
         CollisionCallback,
@@ -1869,7 +1980,7 @@ export declare class PlayerCamera implements protocol.Serializable {
     /** The field of view of the camera. */
     get fov(): number;
     /** The nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching. */
-    get hiddenModelNodes(): Set<string>;
+    get modelHiddenNodes(): Set<string>;
     /** The mode of the camera. */
     get mode(): PlayerCameraMode;
     /** The relative offset of the camera from the entity or position it is attached to. */
@@ -1926,9 +2037,9 @@ export declare class PlayerCamera implements protocol.Serializable {
      * Sets the nodes of the model the camera is attached to
      * that will not be rendered for the player. Uses case
      * insensitive substring matching.
-     * @param hiddenModelNodes - Determines nodes to hide that match these case insensitive substrings.
+     * @param modelHiddenNodes - Determines nodes to hide that match these case insensitive substrings.
      */
-    setHiddenModelNodes(hiddenModelNodes: string[]): void;
+    setModelHiddenNodes(modelHiddenNodes: string[]): void;
     /**
      * Sets the mode of the camera.
      * @param mode - The mode to set.
@@ -1991,9 +2102,9 @@ export declare namespace PlayerCameraEventPayload {
         playerCamera: PlayerCamera;
         fov: number;
     }
-    export interface SetHiddenModelNodes {
+    export interface SetModelHiddenNodes {
         playerCamera: PlayerCamera;
-        hiddenModelNodes: string[];
+        modelHiddenNodes: Set<string>;
     }
     export interface SetMode {
         playerCamera: PlayerCamera;
@@ -2026,7 +2137,7 @@ export declare enum PlayerCameraEventType {
     SET_FILM_OFFSET = "PLAYER_CAMERA.SET_FILM_OFFSET",
     SET_FORWARD_OFFSET = "PLAYER_CAMERA.SET_FORWARD_OFFSET",
     SET_FOV = "PLAYER_CAMERA.SET_FOV",
-    SET_HIDDEN_MODEL_NODES = "PLAYER_CAMERA.SET_HIDDEN_MODEL_NODES",
+    SET_MODEL_HIDDEN_NODES = "PLAYER_CAMERA.SET_MODEL_HIDDEN_NODES",
     SET_MODE = "PLAYER_CAMERA.SET_MODE",
     SET_OFFSET = "PLAYER_CAMERA.SET_OFFSET",
     SET_TRACKED_ENTITY = "PLAYER_CAMERA.SET_TRACKED_ENTITY",
@@ -2935,6 +3046,18 @@ export declare class Simulation {
      * @param enabled - Whether to enable debug rendering.
      */
     enableDebugRendering(enabled: boolean): void;
+    /**
+     * Gets the contact manifolds for a pair of colliders.
+     *
+     * @remarks
+     * Contact manifolds will not be returned for contacts that
+     * involve sensors.
+     *
+     * @param colliderHandleA - The handle of the first collider.
+     * @param colliderHandleB - The handle of the second collider.
+     * @returns The contact manifolds, or an empty array if no contact.
+     */
+    getContactManifolds(colliderHandleA: RAPIER.ColliderHandle, colliderHandleB: RAPIER.ColliderHandle): ContactManifold[];
 
 
     /**