prismarine-world 3.4.0 → 3.6.1

package/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: event-promise
+    versions:
+    - ">= 1.a, < 2"
+  - dependency-name: mkdirp
+    versions:
+    - ">= 1.a, < 2"

package/docs/API.md

@@ -179,3 +179,20 @@ It steps exactly 1 block at a time, returning the block coordinates and the face
 #### next()
 
 return null or the next position (Vec3)
+
+### SpiralIterator2d (pos, maxDistance)
+
+`pos` is Vec3
+
+`maxDistance` is number
+
+Iterates outwards along x and z axis in a cubic spiral. First position returned is the starting position. Every step is 1 step away form the previous and next point. 
+
+#### next()
+
+return null or the next position (Vec3)
+
+#### NUMBER_OF_POINTS
+
+Number of points the iterator will return.
+

package/docs/HISTORY.md

@@ -1,5 +1,17 @@
 ## History
 
+### 3.6.1
+
+* Update mcdata
+
+### 3.6.0
+
+* Added match while check intersect (@sefirosweb)
+
+### 3.5.0
+
+* fix getBlock not setting the position of the block
+
 ### 3.4.0
 
 * add block update events

package/examples/iterator.js

@@ -1,12 +1,70 @@
 const Vec3 = require('vec3').Vec3
-const { OctahedronIterator } = require('../index').iterators
+const { ManhattanIterator, SpiralIterator2d, OctahedronIterator } = require('../index').iterators
 
-const iterator = new OctahedronIterator(new Vec3(0, 0, 0), 5)
+console.info('Octahedron Iterator 3D:\n' + iterate3d(new OctahedronIterator(new Vec3(0, 0, 0), 2)))
+console.info('ManhattanIterator Iterator:\n' + iterate2d(new ManhattanIterator(0, 0, 5)))
+console.info('SpiralIterator2d Iterator:\n' + iterate2d(new SpiralIterator2d(new Vec3(0, 0, 0), 4)))
 
-while (true) {
-  const n = iterator.next()
-  if (n === null) {
-    break
+function iterate3d (iter) {
+  let n = iter.next()
+  const result = []
+  const size = 3
+  let counter = 0
+  for (let x = 0; x < size * 2; x++) {
+    for (let y = 0; y < size * 2; y++) {
+      if (!result[x]) result[x] = []
+      for (let z = 0; z < size * 2; z++) {
+        if (!result[x][y]) result[x][y] = []
+        result[x][y][z] = '   '
+      }
+    }
   }
-  console.log(n)
+  console.info(result)
+  while (n) {
+    result[n.x + size][n.y + size][n.z + size] = pad(counter)
+    counter = counter + 1
+    n = iter.next()
+  }
+  let str = 'Layer 0:  ...\n'
+  for (let x = 0; x < size * 2; x++) {
+    let line = ''
+    for (let y = 0; y < size * 2; y++) {
+      for (let z = 0; z < size * 2; z++) {
+        line += '|' + pad(result[x][y][z])
+      }
+      line += '  '
+    }
+    str += line + '\n'
+  }
+  return str
+}
+
+function iterate2d (iter) {
+  let n = iter.next()
+  const result = []
+  const size = 5
+  let counter = 0
+  for (let x = 0; x < size * 2; x++) {
+    for (let z = 0; z < size * 2; z++) {
+      if (!result[x]) result[x] = []
+      result[x][z] = '   '
+    }
+  }
+  while (n) {
+    result[n.x + size][n.z + size] = pad(counter)
+    counter = counter + 1
+    n = iter.next()
+  }
+  let str = ''
+  for (let x = 0; x < size * 2; x++) {
+    for (let z = 0; z < size * 2; z++) {
+      str += '|' + result[x][z]
+    }
+    str += '|\n'
+  }
+  return str
+}
+
+function pad (num) {
+  return num.toString().padStart(3, ' ')
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "prismarine-world",
-  "version": "3.4.0",
+  "version": "3.6.1",
   "description": "The core implementation of the world for prismarine",
   "main": "index.js",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "standard",
     "fix": "standard --fix",
-    "test": "jest --verbose"
+    "test": "mocha --reporter spec --exit"
   },
   "repository": {
     "type": "git",
@@ -21,7 +21,7 @@
     "game"
   ],
   "engines": {
-    "nodejs": ">=8.0.0"
+    "node": ">=8.0.0"
   },
   "enginesStrict": true,
   "author": "Will Franzen <wtfranzen@gmail.com> (http://will.xyz/)",
@@ -33,19 +33,20 @@
   "devDependencies": {
     "buffer-equal": "^1.0.0",
     "flatmap": "0.0.3",
-    "jest": "^26.0.1",
-    "minecraft-data": "^2.47.0",
+    "minecraft-data": "^3.0.0",
     "mkdirp": "^0.5.1",
     "prismarine-chunk": "^1.14.0",
+    "prismarine-world": "file:.",
     "prismarine-provider-anvil": "^2.0.0",
     "prismarine-provider-raw": "^1.0.1",
+    "process": "^0.11.0",
     "range": "0.0.3",
     "rimraf": "^3.0.2",
     "standard": "^16.0.1",
-    "process": "^0.11.0"
+    "expect": "^27.3.1",
+    "mocha": "^9.1.3"
   },
   "dependencies": {
-    "event-promise": "0.0.1",
-    "vec3": "~0.1.3"
+    "vec3": "^0.1.7"
   }
 }

package/src/iterators.js

@@ -1,11 +1,21 @@
 const { Vec3 } = require('vec3')
 
+const BlockFace = {
+  UNKNOWN: -999,
+  BOTTOM: 0,
+  TOP: 1,
+  NORTH: 2,
+  SOUTH: 3,
+  WEST: 4,
+  EAST: 5
+}
+
 // 2D spiral iterator, useful to iterate on
 // columns that are centered on bot position
 // https://en.wikipedia.org/wiki/Taxicab_geometry
 class ManhattanIterator {
   constructor (x, y, maxDistance) {
-    this.maxDistance = maxDistance
+    this.maxDistance = Math.floor(maxDistance)
     this.startx = x
     this.starty = y
     this.x = 2
@@ -90,16 +100,6 @@ class OctahedronIterator {
   }
 }
 
-const BlockFace = {
-  UNKNOWN: -999,
-  BOTTOM: 0,
-  TOP: 1,
-  NORTH: 2,
-  SOUTH: 3,
-  WEST: 4,
-  EAST: 5
-}
-
 // This iterate along a ray starting at `pos` in `dir` direction
 // It steps exactly 1 block at a time, returning the block coordinates
 // and the face by which the ray entered the block.
@@ -204,10 +204,75 @@ class RaycastIterator {
   }
 }
 
+class SpiralIterator2d {
+  /**
+   * Spiral outwards from a central position in growing squares.
+   * Every point has a constant distance to its previous and following position of 1. First point returned is the starting position.
+   * Generates positions like this:
+   * ```text
+   * 16 15 14 13 12
+   * 17  4  3  2 11
+   * 18  5  0  1 10
+   * 19  6  7  8  9
+   * 20 21 22 23 24
+   * (maxDistance = 2; points returned = 25)
+   * ```
+   * Copy and past warrior source: https://stackoverflow.com/questions/3706219/algorithm-for-iterating-over-an-outward-spiral-on-a-discrete-2d-grid-from-the-or
+   * @param {Vec3} pos Starting position
+   * @param {number} maxDistance Max distance from starting position
+   */
+  constructor (pos, maxDistance) {
+    this.start = pos
+    this.maxDistance = maxDistance
+
+    this.NUMBER_OF_POINTS = Math.floor(Math.pow((Math.floor(maxDistance) - 0.5) * 2, 2))
+
+    // (di, dj) is a vector - direction in which we move right now
+    this.di = 1
+    this.dj = 0
+    // length of current segment
+    this.segment_length = 1
+    // current position (i, j) and how much of current segment we passed
+    this.i = 0
+    this.j = 0
+    this.segment_passed = 0
+    // current iteration
+    this.k = 0
+  }
+
+  next () {
+    if (this.k >= this.NUMBER_OF_POINTS) return null
+    const output = this.start.offset(this.i, 0, this.j)
+
+    // make a step, add 'direction' vector (di, dj) to current position (i, j)
+    this.i += this.di
+    this.j += this.dj
+    this.segment_passed += 1
+
+    if (this.segment_passed === this.segment_length) {
+      // done with current segment
+      this.segment_passed = 0
+
+      // 'rotate' directions
+      const buffer = this.di
+      this.di = -this.dj
+      this.dj = buffer
+
+      // increase segment length if necessary
+      if (this.dj === 0) {
+        this.segment_length += 1
+      }
+    }
+    this.k += 1
+    return output
+  }
+}
+
 module.exports = {
   ManhattanIterator,
   ManathanIterator: ManhattanIterator, // backward compatibility
   OctahedronIterator,
   RaycastIterator,
+  SpiralIterator2d,
   BlockFace
 }

package/src/world.js

@@ -2,7 +2,7 @@ const { Vec3 } = require('vec3')
 const { EventEmitter } = require('events')
 const { RaycastIterator } = require('./iterators')
 const WorldSync = require('./worldsync')
-const once = require('event-promise')
+const { once } = require('events')
 
 function columnKeyXZ (chunkX, chunkZ) {
   return chunkX + ',' + chunkZ
@@ -64,7 +64,6 @@ class World extends EventEmitter {
       if (block && (!matcher || matcher(block))) {
         const intersect = iter.intersect(block.shapes, position)
         if (intersect) {
-          block.position = position
           block.face = intersect.face
           block.intersect = intersect.pos
           return block
@@ -101,6 +100,8 @@ class World extends EventEmitter {
   }
 
   _emitBlockUpdate (oldBlock, newBlock, position) {
+    oldBlock.position = position.floored()
+    newBlock.position = oldBlock.position
     this.emit('blockUpdate', oldBlock, newBlock)
     this.emit(`blockUpdate:${position}`, oldBlock, newBlock)
   }
@@ -202,7 +203,9 @@ class World extends EventEmitter {
   }
 
   async getBlock (pos) {
-    return (await this.getColumnAt(pos)).getBlock(posInChunk(pos))
+    const block = (await this.getColumnAt(pos)).getBlock(posInChunk(pos))
+    block.position = pos.floored()
+    return block
   }
 
   async getBlockStateId (pos) {

package/src/worldsync.js

@@ -43,13 +43,18 @@ class WorldSync extends EventEmitter {
     while (pos) {
       const position = new Vec3(pos.x, pos.y, pos.z)
       const block = this.getBlock(position)
-      if (block && (!matcher || matcher(block))) {
-        const intersect = iter.intersect(block.shapes, position)
-        if (intersect) {
-          block.position = position
-          block.face = intersect.face
-          block.intersect = intersect.pos
-          return block
+      if (block) {
+        if (matcher) {
+          if (matcher(block, iter)) {
+            return block
+          }
+        } else {
+          const intersect = iter.intersect(block.shapes, position)
+          if (intersect) {
+            block.face = intersect.face
+            block.intersect = intersect.pos
+            return block
+          }
         }
       }
       pos = iter.next()
@@ -58,8 +63,10 @@ class WorldSync extends EventEmitter {
   }
 
   _emitBlockUpdate (oldBlock, newBlock, position) {
+    oldBlock.position = position.floored()
+    newBlock.position = oldBlock.position
     this.emit('blockUpdate', oldBlock, newBlock)
-    if (position) this.emit(`blockUpdate:${position}`, oldBlock, newBlock)
+    this.emit(`blockUpdate:${position}`, oldBlock, newBlock)
   }
 
   unloadColumn (chunkX, chunkZ) {
@@ -91,7 +98,9 @@ class WorldSync extends EventEmitter {
   getBlock (pos) {
     const chunk = this.getColumnAt(pos)
     if (!chunk) return null
-    return chunk.getBlock(posInChunk(pos))
+    const block = chunk.getBlock(posInChunk(pos))
+    block.position = pos.floored()
+    return block
   }
 
   getBlockStateId (pos) {
@@ -137,7 +146,7 @@ class WorldSync extends EventEmitter {
     const oldBlock = chunk.getBlock(pInChunk)
     chunk.setBlock(pInChunk, block)
     this.async.saveAt(pos)
-    this._emitBlockUpdate(oldBlock, block)
+    this._emitBlockUpdate(oldBlock, block, pos)
   }
 
   setBlockStateId (pos, stateId) {

package/test/iterator.test.js

@@ -0,0 +1,17 @@
+/* eslint-env mocha */
+
+const { SpiralIterator2d } = require('../src/iterators')
+const { Vec3 } = require('vec3')
+const expect = require('expect')
+
+describe('Spiral iterator', () => {
+  it('simple function test', async () => {
+    const startPos = new Vec3(0, 0, 0)
+    const iter = new SpiralIterator2d(startPos, 2)
+    const first = iter.next()
+    const second = iter.next()
+
+    expect(first.x === startPos.x && first.y === startPos.y && first.z === startPos.z).toBeTruthy()
+    expect(second.x === startPos.x && second.y === startPos.y && second.z === startPos.z).toBeFalsy()
+  })
+})

package/test/raycast.test.js

@@ -1,4 +1,4 @@
-/* eslint-env jest */
+/* eslint-env mocha */
 
 const World = require('prismarine-world')('1.16.4')
 const Chunk = require('prismarine-chunk')('1.16.4')

package/test/test.js

@@ -1,4 +1,4 @@
-/* eslint-env jest */
+/* eslint-env mocha */
 
 const flatMap = require('flatmap')
 const range = require('range').range
@@ -28,11 +28,11 @@ describe('saving and loading works', function () {
   }
 
   const regionPath = 'world/testRegion'
-  beforeAll((cb) => {
+  before((cb) => {
     mkdirp(regionPath, cb)
   })
 
-  afterAll(cb => {
+  after(cb => {
     rimraf(regionPath, cb)
   })
 
@@ -87,11 +87,11 @@ describe('Synchronous saving and loading works', function () {
   }
 
   const regionPath = 'world/testRegionSync'
-  beforeAll((cb) => {
+  before((cb) => {
     mkdirp(regionPath, cb)
   })
 
-  afterAll(cb => {
+  after(cb => {
     rimraf(regionPath, cb)
   })