minerender 2.1.0-alpha.61 → 2.1.0-alpha.63

package/dist/node/index.d.mts

@@ -902,7 +902,7 @@ declare class DefaultBlockStates implements MinecraftAsset {
     [k: string]: BlockStatePropertyDefaults;
 }
 
-/** `entity-models/animations/<namespace>/<model id>.json`: vanilla's keyframe animations of one model. */
+/** `entity-models/animations/<namespace>/<model id>.json`: native and sampled vanilla animation clips. */
 interface EntityAnimationFile extends MinecraftAsset {
     id: string;
     animations: Record<string, EntityAnimation>;
@@ -911,6 +911,8 @@ interface EntityAnimation {
     /** Seconds. */
     length: number;
     loop: boolean;
+    /** Geometry layer targeted by this clip; defaults to `main`. */
+    layer?: string;
     /** Part name anywhere in a layer; `root` is the layer's root part. */
     bones: Record<string, EntityAnimationBone>;
 }
@@ -948,7 +950,7 @@ declare class Entities {
     static getPassList(modelKey: BasicAssetKey): Promise<EntityModelPass[]>;
     static getEntity(modelKey: BasicAssetKey, textureKey?: BasicAssetKey, options?: EntityModelOptions): Promise<Maybe<EntityModel>>;
     /**
-     * Vanilla's keyframe animations of a model by name, or undefined when the model or the selected version has none.
+     * Native and sampled vanilla clips by name, or undefined when the model or selected version has none.
      */
     static getAnimations(modelKey: BasicAssetKey): Promise<Maybe<Record<string, EntityAnimation>>>;
     static resolveTexture(modelKey: BasicAssetKey): Promise<Maybe<AssetKey>>;
@@ -1053,6 +1055,7 @@ interface Instanceable {
     isInstanceActive(index: number, reference: InstanceReference<Instanceable>): boolean;
     getMatrixAt(index: number, matrix?: Matrix4): Matrix4;
     setMatrixAt(index: number, matrix: Matrix4): void;
+    setInstanceVisibleAt(index: number, visible: boolean): void;
     setPositionRotationScaleAt(index: number, position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPositionAt(index: number, position: Vector3): void;
     getPositionAt(index: number, vector?: Vector3): Vector3;
@@ -1074,6 +1077,7 @@ declare class InstanceReference<T extends Instanceable> implements Transformable
     dispose(): void;
     getMatrix(matrix?: Matrix4): Matrix4;
     setMatrix(matrix: Matrix4): void;
+    setVisible(visible: boolean): void;
     setPositionRotationScale(position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPosition(position: Vector3): void;
     getPosition(): Vector3;
@@ -1210,11 +1214,11 @@ declare class EntityAnimationPlayer {
     get animation(): EntityAnimation | undefined;
     get time(): number;
     /**
-     * Starts an animation on the named parts below each layer root. The current pose of a part becomes its default;
-     * bones without a matching part are skipped.
+     * Starts an animation on matching named parts. Supplied baked poses are the baseline for offsets;
+     * without them, the current pose is used. Stopping restores the pose from before playback.
      */
-    play(layers: Object3D[], animation: EntityAnimation, options?: EntityAnimationOptions): void;
-    /** Restores the default poses. Returns whether an animation was active. */
+    play(layers: Object3D[], animation: EntityAnimation, options?: EntityAnimationOptions, poses?: ReadonlyMap<Object3D, EntityModelPart["pose"]>): void;
+    /** Restores the poses from before playback. Returns whether an animation was active. */
     stop(): boolean;
     /** Forgets the animation without touching the parts, for parts that no longer exist. */
     clear(): void;
@@ -1236,7 +1240,8 @@ declare class EntityObject extends SceneObject {
     private scrollTicker;
     /** Entity age in ticks, as vanilla's `ageInTicks`; drives the scrolling render modes. */
     age: number;
-    private readonly animationPlayer;
+    private readonly animationPlayers;
+    private readonly partPoses;
     constructor(entity: EntityModel, options?: Partial<EntityObjectOptions>);
     init(): Promise<void>;
     dispose(): void;
@@ -1245,17 +1250,21 @@ declare class EntityObject extends SceneObject {
     private updateScrollSubscription;
     /** Applies the entity age to the scrolling materials; the ticker calls this 20 times per second. */
     private updateScroll;
-    /** The animation started by {@link playAnimation}, until {@link stopAnimation} or disposal. */
+    /** The first active clip, until playback is stopped or the object is disposed. */
     get animation(): Maybe<EntityAnimation>;
+    /** Clips playing together, each targeting a separate geometry layer. */
+    get activeAnimations(): readonly EntityAnimation[];
     /** Seconds since the animation started, before looping. */
     get animationTime(): number;
     /**
-     * Poses the object from a keyframe animation of {@link Entities.getAnimations}, replacing the current one.
-     * Parts of every layer are matched by name and their current pose is the default the offsets add to.
+     * Plays a clip from {@link Entities.getAnimations}, replacing all active clips.
+     * Offsets apply to the baked pose in the clip's layer (`main` by default), including repeated draws of that layer.
      * The object owns no clock: call {@link advanceAnimation} per frame, or {@link setAnimationTime}.
      */
     playAnimation(animation: EntityAnimation, options?: EntityAnimationOptions): void;
-    /** Stops the animation and restores the default pose. */
+    /** Plays one clip per selected geometry layer, with a shared clock and no blending between clips. */
+    playAnimations(animations: readonly EntityAnimation[], options?: EntityAnimationOptions): void;
+    /** Stops all clips and restores the poses from before playback. */
     stopAnimation(): void;
     /** Poses the object at an explicit time in seconds. Has no effect without an animation. */
     setAnimationTime(seconds: number): void;
@@ -1359,6 +1368,7 @@ declare class SceneObject extends Object3D<Object3DEventMap & {
     protected instanceMesh?: InstancedMesh;
     private readonly instanceReferences;
     private readonly freeInstanceIndices;
+    private readonly hiddenInstanceMatrices;
     constructor(options?: Partial<SceneObjectOptions>);
     set scene(scene: MineRenderScene);
     get scene(): MineRenderScene;
@@ -1406,6 +1416,7 @@ declare class SceneObject extends Object3D<Object3DEventMap & {
     protected activeInstanceIndices(): Iterable<number>;
     getMatrixAt(index: number, matrix?: Matrix4): Matrix4;
     setMatrixAt(index: number, matrix: Matrix4): void;
+    setInstanceVisibleAt(index: number, visible: boolean): void;
     setPositionRotationScaleAt(index: number, position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPositionAt(index: number, position: Vector3): void;
     getPositionAt(index: number, vector?: Vector3): Vector3;
@@ -1473,6 +1484,8 @@ declare class BlockObject extends SceneObject {
     private removeEntities;
     /** Entity models drawn for this block instead of its block model; they are scene children, unlike the block. */
     get blockEntities(): readonly EntityObject[];
+    /** Sets visibility for this block's model instances and block entities. */
+    setVisible(visible: boolean): void;
     /**
      * Draws the block through the dataset's block-entity index. Returns false, leaving nothing behind,
      * when the block is not listed or one of its models cannot be loaded.
@@ -2302,6 +2315,7 @@ declare class Chunk<SectionMeshing extends boolean = false> {
     private readonly data;
     private readonly renderedBlocks;
     private readonly sectionBlocks;
+    private readonly hiddenBlocks;
     private sectionMesh?;
     private meshDirty;
     constructor(scene: MineRenderScene, x: number, y: number, z: number, onBlocksChanged?: ((positions: Vector3[]) => Promise<void>) | undefined, sectionModels?: SectionModels | undefined);
@@ -2318,6 +2332,8 @@ declare class Chunk<SectionMeshing extends boolean = false> {
      * Set a block at integer chunk-local coordinates from 0 to 15.
      */
     setBlockInChunkAt(pos: Vector3, block?: Block, worldPos?: Vector3, onBlocksChanged?: ((positions: Vector3[]) => Promise<void>) | undefined): Promise<Maybe<BlockInfo<SectionMeshing>>>;
+    setBlockVisibleAt(pos: Vector3, visible: boolean): Promise<void>;
+    isBlockVisibleAt(pos: Vector3): boolean;
     isOccludingAt(pos: Vector3): boolean;
     setCullMaskAt(pos: Vector3, mask: number): Promise<void>;
     rebuildSectionMesh(): void;
@@ -2343,6 +2359,13 @@ declare class MineRenderWorld<SectionMeshing extends boolean = false> {
     setBlockAt(pos: Vector3, block: Maybe<Block>): Promise<Maybe<BlockInfo<SectionMeshing>>>;
     setBlockAt(pos: TripleArray, block: Maybe<Block>): Promise<Maybe<BlockInfo<SectionMeshing>>>;
     private placeBlock;
+    /**
+     * Shows or hides a placed block without changing its data. Hidden blocks do not occlude neighbors.
+     * Missing blocks are ignored; replacing or removing a block resets its visibility.
+     */
+    setBlockVisibleAt(x: number, y: number, z: number, visible: boolean): Promise<void>;
+    setBlockVisibleAt(pos: Vector3, visible: boolean): Promise<void>;
+    setBlockVisibleAt(pos: TripleArray, visible: boolean): Promise<void>;
     placeMultiBlock(multiblock: MultiBlockStructure, useBatches?: boolean, executor?: BatchedExecutor): Promise<void>;
     private placeBlocks;
     /** Replaces one chunk column's blocks. Entity NBT remains available on the parsed chunk. */

package/dist/node/index.d.ts

@@ -902,7 +902,7 @@ declare class DefaultBlockStates implements MinecraftAsset {
     [k: string]: BlockStatePropertyDefaults;
 }
 
-/** `entity-models/animations/<namespace>/<model id>.json`: vanilla's keyframe animations of one model. */
+/** `entity-models/animations/<namespace>/<model id>.json`: native and sampled vanilla animation clips. */
 interface EntityAnimationFile extends MinecraftAsset {
     id: string;
     animations: Record<string, EntityAnimation>;
@@ -911,6 +911,8 @@ interface EntityAnimation {
     /** Seconds. */
     length: number;
     loop: boolean;
+    /** Geometry layer targeted by this clip; defaults to `main`. */
+    layer?: string;
     /** Part name anywhere in a layer; `root` is the layer's root part. */
     bones: Record<string, EntityAnimationBone>;
 }
@@ -948,7 +950,7 @@ declare class Entities {
     static getPassList(modelKey: BasicAssetKey): Promise<EntityModelPass[]>;
     static getEntity(modelKey: BasicAssetKey, textureKey?: BasicAssetKey, options?: EntityModelOptions): Promise<Maybe<EntityModel>>;
     /**
-     * Vanilla's keyframe animations of a model by name, or undefined when the model or the selected version has none.
+     * Native and sampled vanilla clips by name, or undefined when the model or selected version has none.
      */
     static getAnimations(modelKey: BasicAssetKey): Promise<Maybe<Record<string, EntityAnimation>>>;
     static resolveTexture(modelKey: BasicAssetKey): Promise<Maybe<AssetKey>>;
@@ -1053,6 +1055,7 @@ interface Instanceable {
     isInstanceActive(index: number, reference: InstanceReference<Instanceable>): boolean;
     getMatrixAt(index: number, matrix?: Matrix4): Matrix4;
     setMatrixAt(index: number, matrix: Matrix4): void;
+    setInstanceVisibleAt(index: number, visible: boolean): void;
     setPositionRotationScaleAt(index: number, position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPositionAt(index: number, position: Vector3): void;
     getPositionAt(index: number, vector?: Vector3): Vector3;
@@ -1074,6 +1077,7 @@ declare class InstanceReference<T extends Instanceable> implements Transformable
     dispose(): void;
     getMatrix(matrix?: Matrix4): Matrix4;
     setMatrix(matrix: Matrix4): void;
+    setVisible(visible: boolean): void;
     setPositionRotationScale(position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPosition(position: Vector3): void;
     getPosition(): Vector3;
@@ -1210,11 +1214,11 @@ declare class EntityAnimationPlayer {
     get animation(): EntityAnimation | undefined;
     get time(): number;
     /**
-     * Starts an animation on the named parts below each layer root. The current pose of a part becomes its default;
-     * bones without a matching part are skipped.
+     * Starts an animation on matching named parts. Supplied baked poses are the baseline for offsets;
+     * without them, the current pose is used. Stopping restores the pose from before playback.
      */
-    play(layers: Object3D[], animation: EntityAnimation, options?: EntityAnimationOptions): void;
-    /** Restores the default poses. Returns whether an animation was active. */
+    play(layers: Object3D[], animation: EntityAnimation, options?: EntityAnimationOptions, poses?: ReadonlyMap<Object3D, EntityModelPart["pose"]>): void;
+    /** Restores the poses from before playback. Returns whether an animation was active. */
     stop(): boolean;
     /** Forgets the animation without touching the parts, for parts that no longer exist. */
     clear(): void;
@@ -1236,7 +1240,8 @@ declare class EntityObject extends SceneObject {
     private scrollTicker;
     /** Entity age in ticks, as vanilla's `ageInTicks`; drives the scrolling render modes. */
     age: number;
-    private readonly animationPlayer;
+    private readonly animationPlayers;
+    private readonly partPoses;
     constructor(entity: EntityModel, options?: Partial<EntityObjectOptions>);
     init(): Promise<void>;
     dispose(): void;
@@ -1245,17 +1250,21 @@ declare class EntityObject extends SceneObject {
     private updateScrollSubscription;
     /** Applies the entity age to the scrolling materials; the ticker calls this 20 times per second. */
     private updateScroll;
-    /** The animation started by {@link playAnimation}, until {@link stopAnimation} or disposal. */
+    /** The first active clip, until playback is stopped or the object is disposed. */
     get animation(): Maybe<EntityAnimation>;
+    /** Clips playing together, each targeting a separate geometry layer. */
+    get activeAnimations(): readonly EntityAnimation[];
     /** Seconds since the animation started, before looping. */
     get animationTime(): number;
     /**
-     * Poses the object from a keyframe animation of {@link Entities.getAnimations}, replacing the current one.
-     * Parts of every layer are matched by name and their current pose is the default the offsets add to.
+     * Plays a clip from {@link Entities.getAnimations}, replacing all active clips.
+     * Offsets apply to the baked pose in the clip's layer (`main` by default), including repeated draws of that layer.
      * The object owns no clock: call {@link advanceAnimation} per frame, or {@link setAnimationTime}.
      */
     playAnimation(animation: EntityAnimation, options?: EntityAnimationOptions): void;
-    /** Stops the animation and restores the default pose. */
+    /** Plays one clip per selected geometry layer, with a shared clock and no blending between clips. */
+    playAnimations(animations: readonly EntityAnimation[], options?: EntityAnimationOptions): void;
+    /** Stops all clips and restores the poses from before playback. */
     stopAnimation(): void;
     /** Poses the object at an explicit time in seconds. Has no effect without an animation. */
     setAnimationTime(seconds: number): void;
@@ -1359,6 +1368,7 @@ declare class SceneObject extends Object3D<Object3DEventMap & {
     protected instanceMesh?: InstancedMesh;
     private readonly instanceReferences;
     private readonly freeInstanceIndices;
+    private readonly hiddenInstanceMatrices;
     constructor(options?: Partial<SceneObjectOptions>);
     set scene(scene: MineRenderScene);
     get scene(): MineRenderScene;
@@ -1406,6 +1416,7 @@ declare class SceneObject extends Object3D<Object3DEventMap & {
     protected activeInstanceIndices(): Iterable<number>;
     getMatrixAt(index: number, matrix?: Matrix4): Matrix4;
     setMatrixAt(index: number, matrix: Matrix4): void;
+    setInstanceVisibleAt(index: number, visible: boolean): void;
     setPositionRotationScaleAt(index: number, position?: Vector3, rotation?: Euler, scale?: Vector3): void;
     setPositionAt(index: number, position: Vector3): void;
     getPositionAt(index: number, vector?: Vector3): Vector3;
@@ -1473,6 +1484,8 @@ declare class BlockObject extends SceneObject {
     private removeEntities;
     /** Entity models drawn for this block instead of its block model; they are scene children, unlike the block. */
     get blockEntities(): readonly EntityObject[];
+    /** Sets visibility for this block's model instances and block entities. */
+    setVisible(visible: boolean): void;
     /**
      * Draws the block through the dataset's block-entity index. Returns false, leaving nothing behind,
      * when the block is not listed or one of its models cannot be loaded.
@@ -2302,6 +2315,7 @@ declare class Chunk<SectionMeshing extends boolean = false> {
     private readonly data;
     private readonly renderedBlocks;
     private readonly sectionBlocks;
+    private readonly hiddenBlocks;
     private sectionMesh?;
     private meshDirty;
     constructor(scene: MineRenderScene, x: number, y: number, z: number, onBlocksChanged?: ((positions: Vector3[]) => Promise<void>) | undefined, sectionModels?: SectionModels | undefined);
@@ -2318,6 +2332,8 @@ declare class Chunk<SectionMeshing extends boolean = false> {
      * Set a block at integer chunk-local coordinates from 0 to 15.
      */
     setBlockInChunkAt(pos: Vector3, block?: Block, worldPos?: Vector3, onBlocksChanged?: ((positions: Vector3[]) => Promise<void>) | undefined): Promise<Maybe<BlockInfo<SectionMeshing>>>;
+    setBlockVisibleAt(pos: Vector3, visible: boolean): Promise<void>;
+    isBlockVisibleAt(pos: Vector3): boolean;
     isOccludingAt(pos: Vector3): boolean;
     setCullMaskAt(pos: Vector3, mask: number): Promise<void>;
     rebuildSectionMesh(): void;
@@ -2343,6 +2359,13 @@ declare class MineRenderWorld<SectionMeshing extends boolean = false> {
     setBlockAt(pos: Vector3, block: Maybe<Block>): Promise<Maybe<BlockInfo<SectionMeshing>>>;
     setBlockAt(pos: TripleArray, block: Maybe<Block>): Promise<Maybe<BlockInfo<SectionMeshing>>>;
     private placeBlock;
+    /**
+     * Shows or hides a placed block without changing its data. Hidden blocks do not occlude neighbors.
+     * Missing blocks are ignored; replacing or removing a block resets its visibility.
+     */
+    setBlockVisibleAt(x: number, y: number, z: number, visible: boolean): Promise<void>;
+    setBlockVisibleAt(pos: Vector3, visible: boolean): Promise<void>;
+    setBlockVisibleAt(pos: TripleArray, visible: boolean): Promise<void>;
     placeMultiBlock(multiblock: MultiBlockStructure, useBatches?: boolean, executor?: BatchedExecutor): Promise<void>;
     private placeBlocks;
     /** Replaces one chunk column's blocks. Entity NBT remains available on the parsed chunk. */