Add isWaterlogged to API (#105)

extremeheat · web-flow · commit bf84ca682255 · 2025-01-24T23:10:39.000+01:00
* Add waterlog to api

* update types

* investigate test fail

* ok
diff --git a/doc/API.md b/doc/API.md
@@ -49,21 +49,27 @@ Tells you how long it will take to dig the block, in milliseconds.
  * `enchantments` list of enchantments from the held item (from simplified nbt data) **AND** equipped armor - Aqua Affinity enchantment on helmet also affects breaking speed
  * `effects` effects on the bot (bot.entity.effects)
 
-#### block.position
+#### block.stateId
 
-Vec3 instance.
+The numeric ID for this block and its state, post-flattening. Pre-flattening, this is generated by combining the block ID and the metadata bits into one integer.
 
 #### block.type
 
-Numerical id.
+The numeric ID for this block, pre-flattening. Post-flattening, this holds the index for the block in minecraft-data's block list.
 
 #### block.name
 
-Minecraft ID (string) of the block.
+A string used to uniquely identify this block internally.
 
 #### block.displayName
 
-Display name of the block.
+The English formatted display name for this block.
+
+#### block.position
+
+Vec3 instance.
+
+*Note: This is not present on prismarine-block instantiation, it's defined externally by prismarine-chunk's `getBlock` methods.*
 
 #### block.shapes
 
@@ -113,6 +119,9 @@ If the block is a painting, contains information about the painting.
 
 Boolean, whether the block is considered diggable.
 
+#### block.isWaterlogged
+Whether the block's state is currently waterlogged. This is only possible since [the aqatic update](https://minecraft.wiki/w/Update_Aquatic).
+
 #### block.boundingBox
 
 The shape of the block according to the physics engine's collision detection. Currently one of:
diff --git a/index.d.ts b/index.d.ts
@@ -25,6 +25,9 @@ export declare class Block {
      */
     constructor(type: number, biomeId: number, metadata: number, stateId?: number);
 
+    // The numeric ID for this block and its state, post-flattening. Pre-flattening, this is generated by combining the block ID and the metadata bits into one integer.
+    stateId: number;
+    // The numeric ID for this block, pre-flattening. Post-flattening, this holds the index for the block in minecraft-data's block list.
     type: number;
 
     /**
@@ -52,13 +55,6 @@ export declare class Block {
      */
     biome: Biome;
 
-    /**
-     * Position of the block
-     */
-    position: Vec3;
-
-    stateId?: number;
-
     /**
      * Minecraft Id (string) of the block
      * @example diamond_ore
@@ -97,6 +93,9 @@ export declare class Block {
      */
     diggable: boolean;
 
+    // Whether the block's state is currently waterlogged. This is only possible since [the aqatic update](https://minecraft.wiki/w/Update_Aquatic).
+    isWaterlogged?: boolean
+
     /**
      * This tells what types of tools will be effective against the block.
      * Possible values are: null, rock, wood, plant, melon, leaves, dirt, web, and wool.
@@ -183,12 +182,15 @@ export declare class Block {
      */
     static fromString(stateString: string, biomeId: number): Block;
 
+    // Position of the block (mineflayer)
+    position: Vec3;
+
     /**
      * (Bedrock Edition) Returns an integer hash to represent the block state
      * @param prefixedName name of the block, with a minecraft: prefix
      * @param states a record of block state properties
      */
-    static getHash(prefixedName: string, states: States): number | undefined
+    static getHash(prefixedName: string, states: States): number | undefined;
 }
 
 /** @deprecated */
diff --git a/index.js b/index.js
@@ -163,6 +163,7 @@ function provider (registry, { Biome, version }) {
         this.diggable = false
       }
 
+      // Properties - this is set for all versions even those with metadata
       this._properties = {}
       if (version.type === 'pc') {
         if (usesBlockStates) {
@@ -183,15 +184,19 @@ function provider (registry, { Biome, version }) {
               if (this._properties) break
             }
           }
+          this._properties ??= {}
         }
       } else if (version.type === 'bedrock') {
         const states = registry.blockStates?.[this.stateId]?.states || {}
         for (const state in states) {
           this._properties[state] = states[state].value
         }
+      } else {
+        throw new Error('Unknown registry type: ' + version.type)
       }
+      this.isWaterlogged = this._properties.waterlogged
 
-      // This can be expanded to other non-sign related things
+      // Extras - Inject helper methods based on the specific block type.
       if (this.name.includes('sign')) {
         mergeObject(this, blockMethods.sign)
       }

Original file line number	Diff line number	Diff line change
`@@ -163,6 +163,7 @@ function provider (registry, { Biome, version }) {`
`163`	`163`	`this.diggable = false`
`164`	`164`	`}`
`165`	`165`
	`166`	`+ // Properties - this is set for all versions even those with metadata`
`166`	`167`	`this._properties = {}`
`167`	`168`	`if (version.type === 'pc') {`
`168`	`169`	`if (usesBlockStates) {`
`@@ -183,15 +184,19 @@ function provider (registry, { Biome, version }) {`
`183`	`184`	`if (this._properties) break`
`184`	`185`	`}`
`185`	`186`	`}`
	`187`	`+ this._properties ??= {}`
`186`	`188`	`}`
`187`	`189`	`} else if (version.type === 'bedrock') {`
`188`	`190`	`const states = registry.blockStates?.[this.stateId]?.states \|\| {}`
`189`	`191`	`for (const state in states) {`
`190`	`192`	`this._properties[state] = states[state].value`
`191`	`193`	`}`
	`194`	`+ } else {`
	`195`	`+ throw new Error('Unknown registry type: ' + version.type)`
`192`	`196`	`}`
	`197`	`+ this.isWaterlogged = this._properties.waterlogged`
`193`	`198`
`194`		`- // This can be expanded to other non-sign related things`
	`199`	`+ // Extras - Inject helper methods based on the specific block type.`
`195`	`200`	`if (this.name.includes('sign')) {`
`196`	`201`	`mergeObject(this, blockMethods.sign)`
`197`	`202`	`}`