Update digging.js for state changes #3136

Vakore · 2023-07-31T23:57:17Z

Made digging.js compatible with state changes, i.e. when the bot switches from being on ground to not on ground and in water, the digging progress is saved and accurately updated.

Vakore · 2023-08-01T00:05:12Z

I have no idea if this would break other people's projects due to variable name changes/complete functionality differences, but the reason for suggesting this fix would be because currently if the bot starts digging a block in one state, i.e. in the water, and then exits the water, or vice versa, the time needed till completion is not adjusted accordingly.

rom1504 · 2023-08-05T13:42:59Z

/fixlint

rom1504 · 2023-08-05T13:43:33Z

please remove commented code

rom1504bot · 2023-08-05T13:43:38Z

I ran npm run fix, but there are errors still left that must be manually resolved:

> mineflayer@4.10.1 fix
> standard --fix && standard-markdown --fix

  /home/runner/work/mineflayer/mineflayer/lib/plugins/digging.js:24:30: Expected '!==' and instead saw '!='. (eqeqeq)
  /home/runner/work/mineflayer/mineflayer/lib/plugins/digging.js:114:11: 'waitTime' is assigned a value but never used. (no-unused-vars)
standard: Use JavaScript Standard Style (https://standardjs.com)

Vakore · 2023-08-05T18:41:21Z

I believe I have made the appropriate changes, though I missed a piece of commented debugging code on line 75.
Vakore@4471376

rom1504 · 2023-08-13T05:56:47Z

lib/plugins/digging.js

+    // bot.referenceTime = window.performance.now();
+    waitInterval = setInterval(() => { //! !!!
+      bot.digPercentage += (50 / bot.digTime(block))
+      // bot.digPercentage += (Math.abs(bot.referenceTime - window.performance.now()) / bot.digTime(block));


Remove commented code

rom1504 · 2023-08-13T05:58:09Z

Clean it up please

rom1504 · 2023-08-13T21:28:10Z

lib/plugins/digging.js

-            0.5 + (i === 'y' ? visibleFaces[i] * 0.5 : 0),
-            0.5 + (i === 'z' ? visibleFaces[i] * 0.5 : 0)
-          )
+          const targetPos = block.position.offset(0.5 + (i === 'x' ? visibleFaces[i] * 0.5 : 0), 0.5 + (i === 'y' ? visibleFaces[i] * 0.5 : 0), 0.5 + (i === 'z' ? visibleFaces[i] * 0.5 : 0))


this is only a formatting change, undo

rom1504 · 2023-08-13T21:28:35Z

lib/plugins/digging.js

-        const dx = bot.entity.position.x - (block.position.x + 0.5)
-        const dy = bot.entity.position.y + bot.entity.height - (block.position.y + 0.5)
-        const dz = bot.entity.position.z - (block.position.z + 0.5)
+        const dx = bot.entity.position.x - block.position.x + 0.5


this is only a formatting change, undo

rom1504 · 2023-08-13T21:28:53Z

lib/plugins/digging.js

+        const dx = bot.entity.position.x - block.position.x + 0.5
+        const dy = bot.entity.position.y - block.position.y - 0.5 + bot.entity.height // -0.5 because the bot position
+        // is calculated from the block position that is inside its feet so 0.5 - 1 = -0.5
+        const dz = bot.entity.position.z - block.position.z + 0.5


this is incorrect

rom1504 · 2023-08-13T21:29:02Z

lib/plugins/digging.js

-            const cDist = new Vec3(tPos.x, tPos.y, tPos.z).distanceSquared(
-              bot.entity.position.offset(0, bot.entity.height, 0)
-            )
+            const cDist = new Vec3(tPos.x, tPos.y, tPos.z).distanceSquared(bot.entity.position.offset(0, bot.entity.height, 0))


this is only a formatting change, undo

rom1504 · 2023-08-13T21:29:05Z

lib/plugins/digging.js

-                            rayPos.y === block.position.y &&
-                            rayPos.z === block.position.z
-            ) {
+            if (rayPos.x === block.position.x && rayPos.y === block.position.y && rayPos.z === block.position.z) {


this is only a formatting change, undo

rom1504 · 2023-08-13T21:29:14Z

lib/plugins/digging.js

-      enchantments,
-      bot.entity.effects
-    )
+    return block.digTime(type, creative, bot.entity.isInWater, !bot.entity.onGround, enchantments, bot.entity.effects)


this is only a formatting change, undo

rom1504 · 2023-08-13T21:29:19Z

lib/plugins/digging.js

-            block.diggable &&
-            block.position.offset(0.5, 0.5, 0.5).distanceTo(bot.entity.position.offset(0, 1.65, 0)) <= 5.1
-    )
+    return block && block.diggable && block.position.offset(0.5, 0.5, 0.5).distanceTo(bot.entity.position.offset(0, 1.65, 0)) <= 5.1


this is only a formatting change, undo

rom1504 · 2023-08-13T21:29:52Z

lib/plugins/digging.js

-          block.position.offset(0.5, 0.5, 0.5).offset(digFace.x * 0.5, digFace.y * 0.5, digFace.z * 0.5),
-          forceLook
-        )
+        await bot.lookAt(block.position.offset(0.5, 0.5, 0.5).offset(digFace.x * 0.5, digFace.y * 0.5, digFace.z * 0.5), forceLook)


this is only a formatting change, undo

rom1504 · 2023-08-13T21:41:15Z

lib/plugins/digging.js

@@ -162,13 +184,14 @@ function inject (bot) {
    function onBlockUpdate (oldBlock, newBlock) {
      // vanilla server never actually interrupt digging, but some server send block update when you start digging
      // so ignore block update if not air
-      // All block update listeners receive (null, null) when the world is unloaded. So newBlock can be null.
-      if (newBlock?.type !== 0) return
+      if (!newBlock) return


this doesn't change anything, see the ? below
you can remove this change

rom1504 · 2023-08-13T21:42:02Z

lib/plugins/digging.js

+      } else {
+        clearInterval(swingInterval)
+      }
+    }, 250)


why the change from 350 to 250 ?

@Vakore can you change this back or give w reason to why you changed the interval?

I changed the interval to fix the arm swing bug

rom1504 · 2023-08-13T21:43:54Z

lib/plugins/digging.js

-    waitTimeout = setTimeout(finishDigging, waitTime)
+    if (waitInterval) { clearInterval(waitInterval) }
+    waitInterval = setInterval(() => {
+      bot.digPercentage += (50 / bot.digTime(block))


does the vanilla client follow this algorithm when state change while digging ? do you have a reference ?

Probably not this exact algorithm but it mimics what I've seen in game, and I've yet to see something abnormal from it.

Vakore · 2023-08-13T21:48:31Z

What I am attempting to change can be mostly summarized by these two changes.

The first change(upper) is meant to fix an issue with the digging function. In Minecraft, if a player starts digging a block while on the ground, then there is a definitive time it will take to break the block if the player continues digging and stays on the ground. Likewise, with if the player mines a block while in the air, or underwater. This is what the original code assumes.

The problem with this is the time to finish breaking something will vary if the player switches between these states(on the ground, in the air, underwater), so if it were to take 1 second to mine a block while grounded the entire time, but 2 seconds when in the air, and the player spends the first half of the digging progress on the ground and the second half in the air, it'll break in 1.5 seconds. Mineflayer currently does not account for this. If the bot begins mining while in the air, then lands on the ground, it will not finish breaking the block until the first computed time, that is the 'in the air' time, has elapsed.

The changes relating to 'digPercentage' allow for the progress to be properly stored and calculated as the mineflayer bot breaks blocks while constantly switching these states, and more accurate to a vanilla client's behavior to my knowledge.

The second change is relating to a common 'arm swinging' bug when breaking blocks. Sometimes, the arm keeps swinging and will never stop. The changes I made add a safety check to the interval to make sure not to swing the arm if the bot isn't breaking a block, and if it isn't, clear the swing interval. The change from '350' to '250' is simply to make the arm swing speed faster and closer to vanilla, though I don't think I made it fast enough to match the vanilla client's arm swinging speed.

IceTank · 2023-08-14T06:17:19Z

lib/plugins/digging.js

@@ -162,13 +184,13 @@ function inject (bot) {
    function onBlockUpdate (oldBlock, newBlock) {
      // vanilla server never actually interrupt digging, but some server send block update when you start digging
      // so ignore block update if not air
-      // All block update listeners receive (null, null) when the world is unloaded. So newBlock can be null.


Why did you remove this comment?

Probably on accident.

Can you add the comment back?

I have a more updated version of digging.js on the discord. Search for attachments from 'Vakore', unable to do stuff with npm rn.

IceTank · 2023-08-14T06:20:20Z

lib/plugins/digging.js

+  bot.on('heldItemChanged', () => {
+    let nameToCompare = ''
+    if (bot.heldItem) { nameToCompare = bot.heldItem.name }
+    if (bot.lastHeldItemName !== nameToCompare) {


I think any held item change cancels the dig process? Even increasing the item amount in a slot.

Surprisingly no. If you have two pickaxes with equal durability and/or nbt, and switch between them, or switch between different fist slots while mining, it won't cancel the mining timer. Mining a tree with fists and picking up a log while mining will reset it, though constantly mining with logs while the stack size increases doesn't last time I checked. I'll double check later today but I'm pretty sure this is correct.

Though now that I'm looking at this the system here won't take into account durability/enchant differences, though that's just nbt and can likely be changed easily. This system will still work in most cases though and is better than nothing, but it should be fixed.

A better way to check if items are equal is the stringify the item and compare that. You could make a string of the item you started mining with and reset the progress if the string of the held item changes.

IceTank · 2023-08-14T06:23:00Z

Btw you don't have to use an external site for linting. Mineflayer comes with its own linter. Just do npm run fix.

rom1504 · 2024-03-17T15:17:09Z

@IceTank do you want to check this one and tell me if it looks good?

Update digging.js for state changes

22e065a

Made digging.js compatible with state changes, i.e. when the bot switches from being on ground to not on ground and in water, the digging progress is saved and accurately updated.

rom1504 added this to Needs triage in PR Triage Aug 5, 2023

Fix linting errors

f5da310

rom1504 moved this from Needs triage to Waiting for user input in PR Triage Aug 5, 2023

rom1504 reviewed Aug 13, 2023

View reviewed changes

Update digging.js

55097ce

rom1504 reviewed Aug 13, 2023

View reviewed changes

Update digging.js

b8bf65c

rom1504 reviewed Aug 13, 2023

View reviewed changes

Update digging.js

1124f5b

rom1504 reviewed Aug 13, 2023

View reviewed changes

Update digging.js

4887102

IceTank reviewed Aug 14, 2023

View reviewed changes

Merge branch 'master' into master

2107785

rom1504 moved this from Waiting for user input to Almost too old in PR Triage Mar 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update digging.js for state changes #3136

Update digging.js for state changes #3136

Vakore commented Jul 31, 2023

Vakore commented Aug 1, 2023

rom1504 commented Aug 5, 2023

rom1504 commented Aug 5, 2023

rom1504bot commented Aug 5, 2023

Vakore commented Aug 5, 2023 •

edited

rom1504 Aug 13, 2023

rom1504 commented Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

rom1504 Aug 13, 2023

IceTank Mar 17, 2024

Vakore Mar 17, 2024

rom1504 Aug 13, 2023

Vakore Aug 13, 2023

Vakore commented Aug 13, 2023

IceTank Aug 14, 2023

Vakore Aug 14, 2023

IceTank Mar 17, 2024

Vakore Mar 17, 2024

IceTank Aug 14, 2023

Vakore Aug 14, 2023 •

edited

IceTank Aug 15, 2023

IceTank commented Aug 14, 2023

rom1504 commented Mar 17, 2024

Update digging.js for state changes #3136

Are you sure you want to change the base?

Update digging.js for state changes #3136

Conversation

Vakore commented Jul 31, 2023

Vakore commented Aug 1, 2023

rom1504 commented Aug 5, 2023

rom1504 commented Aug 5, 2023

rom1504bot commented Aug 5, 2023

Vakore commented Aug 5, 2023 • edited

Choose a reason for hiding this comment

rom1504 commented Aug 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vakore commented Aug 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vakore Aug 14, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IceTank commented Aug 14, 2023

rom1504 commented Mar 17, 2024

Vakore commented Aug 5, 2023 •

edited

Vakore Aug 14, 2023 •

edited