prismarine-physics 1.9.0 → 1.11.0

package/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [24.x]
 
     steps:
     - uses: actions/checkout@v2

package/.github/workflows/publish.yml

@@ -3,6 +3,9 @@ on:
   push:
     branches:
       - master # Change this to your default branch
+permissions:
+  id-token: write
+  contents: write
 jobs:
   npm-publish:
     name: npm-publish
@@ -13,13 +16,12 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@master
       with:
-        node-version: 18.0.0
+        node-version: 24
+        registry-url: 'https://registry.npmjs.org'
     - id: publish
-      uses: JS-DevTools/npm-publish@v1
-      with:
-        token: ${{ secrets.NPM_AUTH_TOKEN }}
+      uses: JS-DevTools/npm-publish@v4
     - name: Create Release
-      if: steps.publish.outputs.type != 'none'
+      if: ${{ steps.publish.outputs.type }}
       id: create_release
       uses: actions/create-release@v1
       env:

package/HISTORY.md

@@ -1,5 +1,18 @@
 ## History
 
+### 1.11.0
+* [Update CI to Node 24 (#129)](https://github.com/PrismarineJS/prismarine-physics/commit/7be0b38f547f186d41fc9cda8841cacf8f2fd80a) (thanks @rom1504)
+* [Fix incorrect elytra physics (#123)](https://github.com/PrismarineJS/prismarine-physics/commit/be7f91bb4ec85e1b1f4ccfa1a33607e9cdfdf92c) (thanks @BossFlea)
+* [fix: add scaffolding to climbable blocks and 1.21 to climbUsingJump (#126)](https://github.com/PrismarineJS/prismarine-physics/commit/06543978564247457c6ac3255c666d64a99c4de4) (thanks @jerry1091)
+* [Fix publish condition for npm-publish v4 (#128)](https://github.com/PrismarineJS/prismarine-physics/commit/45d7e992c58e0f60c18eee633adad783c3e64e0f) (thanks @rom1504)
+* [Switch to trusted publishing via OIDC (#127)](https://github.com/PrismarineJS/prismarine-physics/commit/f34e1d48ece5329d443c58624e2fb55ba3d5cc03) (thanks @rom1504)
+* [node 22 (#122)](https://github.com/PrismarineJS/prismarine-physics/commit/37d8d0b612de347b2e132e270642fec108d4f2ec) (thanks @rom1504)
+
+### 1.10.0
+* [Fix `.isOnLadder()` condition (#111)](https://github.com/PrismarineJS/prismarine-physics/commit/03b2e447b7f867257b8e50170439be8ca8e51743) (thanks @szdytom)
+* [Bump mocha from 10.8.2 to 11.0.1 (#119)](https://github.com/PrismarineJS/prismarine-physics/commit/4a1d37c91915522d824b2d4170fce135926ce6e5) (thanks @dependabot[bot])
+* [Use new block.isWaterlogged over reading block properties (#120)](https://github.com/PrismarineJS/prismarine-physics/commit/5cbba64ec457c6b5fa18002e57b87c8c584abb94) (thanks @extremeheat)
+
 ### 1.9.0
 * [add 1.21 to proportionalliquidgravity setting (#117)](https://github.com/PrismarineJS/prismarine-physics/commit/4986c8e395773e770d461db06bce38f9faed0757) (thanks @Madlykeanu)
 

package/index.js

@@ -34,6 +34,22 @@ function Physics (mcData, world) {
   const lavaIds = [blocksByName.lava.id, blocksByName.flowing_lava ? blocksByName.flowing_lava.id : -1]
   const ladderId = blocksByName.ladder.id
   const vineId = blocksByName.vine.id
+  const scaffoldingId = blocksByName.scaffolding ? blocksByName.scaffolding.id : -1 // 1.14+
+
+  // NOTE: Copper trapdoors is coming in 1.21.
+  const trapdoorIds = new Set()
+  if (blocksByName.iron_trapdoor) { trapdoorIds.add(blocksByName.iron_trapdoor.id) } // 1.8+
+  if (blocksByName.acacia_trapdoor) { trapdoorIds.add(blocksByName.acacia_trapdoor.id) } // 1.13+
+  if (blocksByName.birch_trapdoor) { trapdoorIds.add(blocksByName.birch_trapdoor.id) } // 1.13+
+  if (blocksByName.jungle_trapdoor) { trapdoorIds.add(blocksByName.jungle_trapdoor.id) } // 1.13+
+  if (blocksByName.oak_trapdoor) { trapdoorIds.add(blocksByName.oak_trapdoor.id) } // 1.13+
+  if (blocksByName.dark_oak_trapdoor) { trapdoorIds.add(blocksByName.dark_oak_trapdoor.id) } // 1.13+
+  if (blocksByName.spruce_trapdoor) { trapdoorIds.add(blocksByName.spruce_trapdoor.id) } // 1.13+
+  if (blocksByName.crimson_trapdoor) { trapdoorIds.add(blocksByName.crimson_trapdoor.id) } // 1.16+
+  if (blocksByName.warped_trapdoor) { trapdoorIds.add(blocksByName.warped_trapdoor.id) } // 1.16+
+  if (blocksByName.mangrove_trapdoor) { trapdoorIds.add(blocksByName.mangrove_trapdoor.id) } // 1.19+
+  if (blocksByName.cherry_trapdoor) { trapdoorIds.add(blocksByName.cherry_trapdoor.id) } // 1.20+
+
   const waterLike = new Set()
   if (blocksByName.seagrass) waterLike.add(blocksByName.seagrass.id) // 1.13+
   if (blocksByName.tall_seagrass) waterLike.add(blocksByName.tall_seagrass.id) // 1.13+
@@ -419,9 +435,27 @@ function Physics (mcData, world) {
     vel.z += forward * cos - strafe * sin
   }
 
+  const climbableTrapdoorFeature = supportFeature('climbableTrapdoor')
   function isOnLadder (world, pos) {
     const block = world.getBlock(pos)
-    return (block && (block.type === ladderId || block.type === vineId))
+    if (!block) { return false }
+    if (block.type === ladderId || block.type === vineId) { return true }
+    if (scaffoldingId !== -1 && block.type === scaffoldingId) { return true }
+
+    // Since 1.9, when a trapdoor satisfies the following conditions, it also becomes climbable:
+    //  1. The trapdoor is placed directly above a ladder.
+    //  2. The trapdoor is opened.
+    //  3. The trapdoor and the ladder directly below it face the same direction.
+    if (climbableTrapdoorFeature && trapdoorIds.has(block.type)) {
+      const blockBelow = world.getBlock(pos.offset(0, -1, 0))
+      if (blockBelow.type !== ladderId) { return false } // condition 1.
+      const blockProperties = block._properties
+      if (!blockProperties.open) { return false } // condition 2.
+      if (blockProperties.facing !== blockBelow.getProperties().facing) { return false } // condition 3
+      return true
+    }
+
+    return false
   }
 
   function doesNotCollide (world, pos) {
@@ -484,8 +518,8 @@ function Physics (mcData, world) {
         vel.z += lookDir.z * movingDownSpeedModifier / cosPitch
       }
 
-      if (pitch < 0.0 && cosPitch > 0.0) {
-        const lookDownSpeedModifier = horizontalSpeed * (-sinPitch) * 0.04
+      if (pitch > 0.0 && cosPitch > 0.0) {
+        const lookDownSpeedModifier = horizontalSpeed * sinPitch * 0.04
         vel.x += -lookDir.x * lookDownSpeedModifier / cosPitch
         vel.y += lookDownSpeedModifier * 3.2
         vel.z += -lookDir.z * lookDownSpeedModifier / cosPitch
@@ -592,7 +626,7 @@ function Physics (mcData, world) {
   function getRenderedDepth (block) {
     if (!block) return -1
     if (waterLike.has(block.type)) return 0
-    if (block.getProperties().waterlogged) return 0
+    if (block.isWaterlogged) return 0
     if (!waterIds.includes(block.type)) return -1
     const meta = block.metadata
     return meta >= 8 ? 0 : meta
@@ -640,7 +674,7 @@ function Physics (mcData, world) {
       for (cursor.z = Math.floor(bb.minZ); cursor.z <= Math.floor(bb.maxZ); cursor.z++) {
         for (cursor.x = Math.floor(bb.minX); cursor.x <= Math.floor(bb.maxX); cursor.x++) {
           const block = world.getBlock(cursor)
-          if (block && (waterIds.includes(block.type) || waterLike.has(block.type) || block.getProperties().waterlogged)) {
+          if (block && (waterIds.includes(block.type) || waterLike.has(block.type) || block.isWaterlogged)) {
             const waterLevel = cursor.y + 1 - getLiquidHeightPcent(block)
             if (Math.ceil(bb.maxY) >= waterLevel) waterBlocks.push(block)
           }

package/lib/features.json

@@ -17,11 +17,16 @@
   {
     "name": "velocityBlocksOnTop",
     "description": "Velocity changes are caused by the block the player is standing on",
-    "versions": ["1.15", "1.17", "1.18"]
+    "versions": ["1.15", "1.16", "1.17", "1.18", "1.19", "1.20"]
   },
   {
     "name": "climbUsingJump",
     "description": "Entity can climb ladders and vines by pressing jump",
-    "versions": ["1.14", "1.15", "1.17", "1.18"]
+    "versions": ["1.14", "1.15", "1.16", "1.17", "1.18", "1.19", "1.20", "1.21"]
+  },
+  {
+    "name": "climbableTrapdoor",
+    "description": "Trapdoors placed directly above ladders become climbable",
+    "versions": ["1.9", "1.10", "1.11", "1.12", "1.13", "1.14", "1.15", "1.16", "1.17", "1.18", "1.19", "1.20"]
   }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismarine-physics",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Provide the physics engine for minecraft entities",
   "main": "index.js",
   "directories": {
@@ -29,7 +29,7 @@
   "homepage": "https://github.com/PrismarineJS/prismarine-physics#readme",
   "devDependencies": {
     "expect": "^27.3.1",
-    "mocha": "^10.0.0",
+    "mocha": "^11.0.1",
     "prismarine-block": "^1.7.3",
     "prismarine-physics": "file:./",
     "standard": "^17.0.0"

package/test/elytra.test.js

@@ -490,8 +490,8 @@ describe('Elytra tests', () => {
     expect(webPlayer.entity.position.y).toBeGreaterThan(149)
 
     // elytra player should be far away and much lower
-    expect(airPlayer.entity.position.x).toBeGreaterThan(200)
-    expect(airPlayer.entity.position.y).toBeLessThan(110)
+    expect(airPlayer.entity.position.x).toBeGreaterThan(60)
+    expect(airPlayer.entity.position.y).toBeLessThan(135)
   })
 
   it('can hit a wall', () => {

package/test/scaffolding.test.js

@@ -0,0 +1,152 @@
+/* eslint-env mocha */
+
+const { Physics, PlayerState } = require('prismarine-physics')
+const { Vec3 } = require('vec3')
+const expect = require('expect')
+const features = require('../lib/features.json')
+
+describe('Scaffolding climbable and climbUsingJump feature', () => {
+  describe('features.json', () => {
+    it('climbUsingJump should include version 1.21', () => {
+      const climbUsingJump = features.find(f => f.name === 'climbUsingJump')
+      expect(climbUsingJump).toBeTruthy()
+      expect(climbUsingJump.versions).toContain('1.21')
+    })
+
+    it('climbUsingJump should include versions 1.14 through 1.21', () => {
+      const climbUsingJump = features.find(f => f.name === 'climbUsingJump')
+      for (const v of ['1.14', '1.15', '1.16', '1.17', '1.18', '1.19', '1.20', '1.21']) {
+        expect(climbUsingJump.versions).toContain(v)
+      }
+    })
+  })
+
+  describe('Scaffolding is climbable for versions >= 1.14', () => {
+    for (const version of ['1.14.4', '1.16.5', '1.21']) {
+      it(`should treat scaffolding as climbable in ${version}`, () => {
+        const mcData = require('minecraft-data')(version)
+        const Block = require('prismarine-block')(version)
+
+        const scaffoldingId = mcData.blocksByName.scaffolding.id
+        const stoneId = mcData.blocksByName.stone.id
+        const airId = mcData.blocksByName.air.id
+
+        // World: stone below y=60, scaffolding at y=61, air elsewhere
+        const fakeWorld = {
+          getBlock: (pos) => {
+            let type
+            if (pos.y < 60) {
+              type = stoneId
+            } else if (pos.y === 61 && pos.x === 0 && pos.z === 0) {
+              type = scaffoldingId
+            } else {
+              type = airId
+            }
+            const b = new Block(type, 0, 0)
+            b.position = pos
+            return b
+          }
+        }
+
+        const physics = Physics(mcData, fakeWorld)
+        const controls = {
+          forward: false,
+          back: false,
+          left: false,
+          right: false,
+          jump: true,
+          sprint: false,
+          sneak: false
+        }
+
+        const player = {
+          entity: {
+            position: new Vec3(0, 61, 0),
+            velocity: new Vec3(0, 0, 0),
+            onGround: false,
+            isInWater: false,
+            isInLava: false,
+            isInWeb: false,
+            isCollidedHorizontally: false,
+            isCollidedVertically: false,
+            elytraFlying: false,
+            yaw: 0,
+            pitch: 0,
+            effects: {}
+          },
+          jumpTicks: 0,
+          jumpQueued: false,
+          fireworkRocketDuration: 0,
+          version,
+          inventory: {
+            slots: []
+          }
+        }
+
+        const playerState = new PlayerState(player, controls)
+        physics.simulatePlayer(playerState, fakeWorld).apply(player)
+
+        // When on scaffolding with jump pressed, the player should climb
+        // (velocity.y should be positive, equal to ladderClimbSpeed)
+        expect(player.entity.velocity.y).toBeGreaterThan(0)
+      })
+    }
+  })
+
+  describe('Scaffolding does not exist pre-1.14', () => {
+    it('should not crash when scaffolding block does not exist (1.13.2)', () => {
+      const mcData = require('minecraft-data')('1.13.2')
+      const Block = require('prismarine-block')('1.13.2')
+
+      expect(mcData.blocksByName.scaffolding).toBeFalsy()
+
+      const fakeWorld = {
+        getBlock: (pos) => {
+          const type = (pos.y < 60) ? mcData.blocksByName.stone.id : mcData.blocksByName.air.id
+          const b = new Block(type, 0, 0)
+          b.position = pos
+          return b
+        }
+      }
+
+      // Should not throw
+      const physics = Physics(mcData, fakeWorld)
+      const controls = {
+        forward: false,
+        back: false,
+        left: false,
+        right: false,
+        jump: false,
+        sprint: false,
+        sneak: false
+      }
+
+      const player = {
+        entity: {
+          position: new Vec3(0, 80, 0),
+          velocity: new Vec3(0, 0, 0),
+          onGround: false,
+          isInWater: false,
+          isInLava: false,
+          isInWeb: false,
+          isCollidedHorizontally: false,
+          isCollidedVertically: false,
+          elytraFlying: false,
+          yaw: 0,
+          pitch: 0,
+          effects: {}
+        },
+        jumpTicks: 0,
+        jumpQueued: false,
+        fireworkRocketDuration: 0,
+        version: '1.13.2',
+        inventory: {
+          slots: []
+        }
+      }
+
+      const playerState = new PlayerState(player, controls)
+      physics.simulatePlayer(playerState, fakeWorld).apply(player)
+    })
+  })
+})