hytopia 0.6.6 → 0.6.8

package/server.d.ts

@@ -1287,19 +1287,19 @@ export declare enum CollisionGroup {
     BLOCK = 1,
     ENTITY = 2,
     ENTITY_SENSOR = 4,
-    PLAYER = 8,
-    GROUP_1 = 16,
-    GROUP_2 = 32,
-    GROUP_3 = 64,
-    GROUP_4 = 128,
-    GROUP_5 = 256,
-    GROUP_6 = 512,
-    GROUP_7 = 1024,
-    GROUP_8 = 2048,
-    GROUP_9 = 4096,
-    GROUP_10 = 8192,
-    GROUP_11 = 16384,
-    GROUP_12 = 32768,
+    ENVIRONMENT_ENTITY = 8,
+    PLAYER = 16,
+    GROUP_1 = 32,
+    GROUP_2 = 64,
+    GROUP_3 = 128,
+    GROUP_4 = 256,
+    GROUP_5 = 512,
+    GROUP_6 = 1024,
+    GROUP_7 = 2048,
+    GROUP_8 = 4096,
+    GROUP_9 = 8192,
+    GROUP_10 = 16384,
+    GROUP_11 = 32768,
     ALL = 65535
 }
 
@@ -1749,6 +1749,7 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
 
 
     /**
@@ -1775,6 +1776,8 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     get modelPreferredShape(): ColliderShape | undefined;
     /** The scale of the entity's model. */
     get modelScale(): number;
+    /** The URI or path to the texture that overrides the model entity's default texture. */
+    get modelTextureUri(): string | undefined;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     get modelUri(): string | undefined;
     /** The name of the entity. */
@@ -1808,6 +1811,11 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * Despawns the entity and all children from the world.
      */
     despawn(): void;
+    /**
+     * Sets the controller for the entity.
+     * @param controller - The controller to set.
+     */
+    setController(controller: BaseEntityController | undefined): void;
     /**
      * Sets the playback rate of all animations on the entity's model.
      *
@@ -1819,11 +1827,6 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param playbackRate - The playback rate of the entity's model animations.
      */
     setModelAnimationsPlaybackRate(playbackRate: number): void;
-    /**
-     * Sets the controller for the entity.
-     * @param controller - The controller to set.
-     */
-    setController(controller: BaseEntityController | undefined): void;
     /**
      * Sets the nodes to hide on the entity's model. Matched nodes
      * will be hidden for all players. Uses case insensitive
@@ -1831,6 +1834,12 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param modelHiddenNodes - The nodes to hide on the entity's model.
      */
     setModelHiddenNodes(modelHiddenNodes: string[]): void;
+    /**
+     * Sets the texture uri of the entity's model. Setting
+     * this overrides the model's default texture.
+     * @param modelTextureUri - The texture uri of the entity's model.
+     */
+    setModelTextureUri(modelTextureUri: string | undefined): void;
     /**
      * Sets the opacity of the entity.
      * @param opacity - The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
@@ -1929,6 +1938,7 @@ export declare enum EntityEvent {
     ENTITY_CONTACT_FORCE = "ENTITY.ENTITY_CONTACT_FORCE",
     SET_MODEL_ANIMATIONS_PLAYBACK_RATE = "ENTITY.SET_MODEL_ANIMATIONS_PLAYBACK_RATE",
     SET_MODEL_HIDDEN_NODES = "ENTITY.SET_MODEL_HIDDEN_NODES",
+    SET_MODEL_TEXTURE_URI = "ENTITY.SET_MODEL_TEXTURE_URI",
     SET_OPACITY = "ENTITY.SET_OPACITY",
     SET_PARENT = "ENTITY.SET_PARENT",
     SET_TINT_COLOR = "ENTITY.SET_TINT_COLOR",
@@ -1985,6 +1995,11 @@ export declare interface EntityEventPayloads {
         entity: Entity;
         modelHiddenNodes: Set<string>;
     };
+    /** Emitted when the texture uri of the entity's model is set. */
+    [EntityEvent.SET_MODEL_TEXTURE_URI]: {
+        entity: Entity;
+        modelTextureUri: string | undefined;
+    };
     /** Emitted when the opacity of the entity is set. */
     [EntityEvent.SET_OPACITY]: {
         entity: Entity;
@@ -3230,6 +3245,8 @@ export declare interface ModelEntityOptions extends BaseEntityOptions {
     modelPreferredShape?: ColliderShape;
     /** The scale of the entity's model. */
     modelScale?: number;
+    /** The texture uri of the entity's model. Setting this overrides the model's default texture. */
+    modelTextureUri?: string;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     modelUri?: string;
 }
@@ -3362,6 +3379,8 @@ export declare type MoveOptions = {
     };
     /** Whether to start the idle animations when the entity finishes moving. Defaults to true. */
     moveStartIdleAnimationsOnCompletion?: boolean;
+    /** The distance from the target at which the entity will stop moving and consider movement complete. Defaults to 0.316~ blocks away from target. */
+    moveStoppingDistance?: number;
 };
 
 /** The options for an error type "none" collider. @public */
@@ -3409,6 +3428,10 @@ export declare class PathfindingEntityController extends SimpleEntityController
 
 
 
+    /**
+     * @param options - Options for the controller.
+     */
+    constructor(options?: PathfindingEntityControllerOptions);
     /** Whether to enable debug mode or not. When debug mode is enabled, the pathfinding algorithm will log debug information to the console. Defaults to false. */
     get debug(): boolean;
     /** The maximum fall distance the entity can fall. */
@@ -3446,7 +3469,10 @@ export declare class PathfindingEntityController extends SimpleEntityController
 
 
 
+}
 
+/** Options for creating a PathfindingEntityController instance. @public */
+declare interface PathfindingEntityControllerOptions extends SimpleEntityControllerOptions {
 }
 
 /**
@@ -3646,6 +3672,7 @@ export declare class PlayerCamera extends EventRouter implements protocol.Serial
 
 
 
+
     /** The entity the camera is attached to. */
     get attachedToEntity(): Entity | undefined;
     /** The position the camera is attached to. */
@@ -3666,6 +3693,8 @@ export declare class PlayerCamera extends EventRouter implements protocol.Serial
     get offset(): Vector3Like;
     /** The current orientation of the camera. */
     get orientation(): PlayerCameraOrientation;
+    /** The shoulder angle of the camera in degrees. */
+    get shoulderAngle(): number;
     /** The entity the camera will constantly look at, even if the camera attached or tracked entity moves. */
     get trackedEntity(): Entity | undefined;
     /** The position the camera will constantly look at, even if the camera attached entity moves. */
@@ -3739,6 +3768,14 @@ export declare class PlayerCamera extends EventRouter implements protocol.Serial
     setOffset(offset: Vector3Like): void;
 
 
+    /**
+     * Only used in third-person mode. Sets the shoulder angle
+     * of the camera in degrees. A positive value shifts the
+     * camera to the right, a negative value shifts it to the
+     * left.
+     * @param shoulderAngle - The shoulder angle to set in degrees.
+     */
+    setShoulderAngle(shoulderAngle: number): void;
     /**
      * Sets the entity the camera will constantly look at,
      * even if the camera attached or tracked entity moves.
@@ -3772,6 +3809,7 @@ export declare enum PlayerCameraEvent {
     SET_MODEL_HIDDEN_NODES = "PLAYER_CAMERA.SET_MODEL_HIDDEN_NODES",
     SET_MODE = "PLAYER_CAMERA.SET_MODE",
     SET_OFFSET = "PLAYER_CAMERA.SET_OFFSET",
+    SET_SHOULDER_ANGLE = "PLAYER_CAMERA.SET_SHOULDER_ANGLE",
     SET_TRACKED_ENTITY = "PLAYER_CAMERA.SET_TRACKED_ENTITY",
     SET_TRACKED_POSITION = "PLAYER_CAMERA.SET_TRACKED_POSITION",
     SET_ZOOM = "PLAYER_CAMERA.SET_ZOOM"
@@ -3829,6 +3867,11 @@ export declare interface PlayerCameraEventPayloads {
         playerCamera: PlayerCamera;
         offset: Vector3Like;
     };
+    /** Emitted when the shoulder angle of the camera is set. */
+    [PlayerCameraEvent.SET_SHOULDER_ANGLE]: {
+        playerCamera: PlayerCamera;
+        shoulderAngle: number;
+    };
     /** Emitted when the tracked entity of the camera is set. */
     [PlayerCameraEvent.SET_TRACKED_ENTITY]: {
         playerCamera: PlayerCamera;
@@ -4631,10 +4674,15 @@ export declare class RigidBody extends EventRouter {
     createAndAddChildCollider(colliderOptions: ColliderOptions): Collider | null;
     /**
      * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
+     *
+     * @remarks
+     * If the rigid body is not simulated, the colliders will be added to the rigid body as pending child colliders
+     * and also simulated when the rigid body is simulated.
+     *
      * @param colliderOptions - The options for the child colliders to add to the rigid body.
      * @returns The child colliders that were added to the rigid body.
      */
-    createAndAddChildCollidersToSimulation(colliderOptions: ColliderOptions[]): Collider[];
+    createAndAddChildColliders(colliderOptions: ColliderOptions[]): Collider[];
     /**
      * Gets the colliders of the rigid body by tag.
      * @param tag - The tag to filter by.
@@ -4990,6 +5038,13 @@ export declare class SimpleEntityController extends BaseEntityController {
 
 
 
+
+
+
+    /**
+     * @param options - Options for the controller.
+     */
+    constructor(options?: SimpleEntityControllerOptions);
     /**
      * Override of the {@link BaseEntityController.spawn} method. Starts
      * the set idle animations (if any) when the entity is spawned.
@@ -5029,10 +5084,32 @@ export declare class SimpleEntityController extends BaseEntityController {
      * @param options - Additional options for the move operation, such as callbacks.
      */
     move(target: Vector3Like, speed: number, options?: MoveOptions): void;
+    /**
+     * Stops the entity from attempting to face a target coordinate.
+     */
+    stopFace(): void;
+    /**
+     * Stops the entity from continuing to move it's current target coordinate.
+     */
+    stopMove(): void;
+
 
 
 
+}
 
+/** Options for creating a SimpleEntityController instance. @public */
+declare interface SimpleEntityControllerOptions {
+    /** The animations to loop when the entity is idle. */
+    idleLoopedAnimations?: string[];
+    /** The speed at which to loop the idle animations. */
+    idleLoopedAnimationsSpeed?: number;
+    /** The animations to play when the entity jumps. */
+    jumpOneshotAnimations?: string[];
+    /** The animations to loop when the entity is moving. */
+    moveLoopedAnimations?: string[];
+    /** The speed at which to loop the move animations. */
+    moveLoopedAnimationsSpeed?: number;
 }
 
 /**
@@ -5185,7 +5262,7 @@ export declare interface SpdMatrix3 extends SdpMatrix3 {
 export declare function startServer(init: ((() => void) | ((world: World) => void))): void;
 
 /** The input keys that are included in the PlayerInput. @public */
-export declare const SUPPORTED_INPUT_KEYS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"];
+export declare const SUPPORTED_INPUT_KEYS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "u", "i", "o", "j", "k", "l", "n", "m", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"];
 
 /** The options for a trimesh collider. @public */
 export declare interface TrimeshColliderOptions extends BaseColliderOptions {