prismarine-entity 2.1.1 → 2.3.0

package/.github/workflows/ci.yml

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

package/.github/workflows/commands.yml

@@ -0,0 +1,22 @@
+name: Repo Commands
+
+on:
+  issue_comment:        # Handle comment commands
+    types: [created]
+  pull_request:         # Handle renamed PRs
+    types: [edited]
+
+jobs:
+  comment-trigger:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v3
+    - name: Run command handlers
+      uses: PrismarineJS/prismarine-repo-actions@master
+      with:
+        # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.
+        token: ${{ secrets.PAT_PASSWORD }}
+        # See `Options` section below for more info on these options
+        install-command: npm install
+        /fixlint.fix-command: npm run fix

package/.github/workflows/publish.yml

@@ -13,13 +13,20 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@master
       with:
-        node-version: 10.0.0
-    - name: Publish if version has been updated
-      uses: pascalgn/npm-publish-action@4f4bf159e299f65d21cd1cbd96fc5d53228036df
-      with: # All of theses inputs are optional
-        tag_name: "%s"
-        tag_message: "%s"
-        commit_pattern: "^Release (\\S+)"
-      env: # More info about the environment variables in the README
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this as is, it's automatically generated
-        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} # You need to set this in your repo settings
+        node-version: 18.0.0
+    - id: publish
+      uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_AUTH_TOKEN }}
+    - name: Create Release
+      if: steps.publish.outputs.type != 'none'
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ steps.publish.outputs.version }}
+        release_name: Release ${{ steps.publish.outputs.version }}
+        body: ${{ steps.publish.outputs.version }}
+        draft: false
+        prerelease: false

package/README.md

@@ -81,12 +81,24 @@ get from collecting the orb.
 
 #### entity.equipment[5]
 
+Version dependent. 
+
+1.8 Layout:
+
  * `0` - held item
  * `1` - shoes
  * `2` - legging
  * `3` - torso
  * `4` - head
- 
+
+1.9 and later:
+
+ * `0` - held item
+ * `1` - off-hand
+ * `2` - shoes
+ * `3` - legging
+ * `4` - torso
+ * `5` - head 
 
 #### entity.heldItem
 
@@ -114,6 +126,10 @@ The health of the player, default: 20
 
 The food of the player, default: 20
 
+#### entity.elytraFlying
+
+Whether or not the entity is elytra flying.
+
 #### entity.player
 
 The player
@@ -128,6 +144,20 @@ returns a `prismarine-item` Item object for the dropped item, if this is a dropp
 
 ## History
 
+### 2.3.0
+* [Add default elytra flying value (#69)](https://github.com/PrismarineJS/prismarine-entity/commit/f124abd47b42a908a676b91b0fcb55b1fd1a77b9) (thanks @lkwilson)
+* [Fix equipment documentation for other versions (#67)](https://github.com/PrismarineJS/prismarine-entity/commit/b2f756de52fa7ceb2675fe9c2f950fa7398bc425) (thanks @IceTank)
+* [Add command gh workflow allowing to use release command in comments (#66)](https://github.com/PrismarineJS/prismarine-entity/commit/4dffa63e3dd45b8f3a42575a2f6f3c2fa47d1d50) (thanks @rom1504)
+* [Update to node 18.0.0 (#65)](https://github.com/PrismarineJS/prismarine-entity/commit/7fe14b95f82089b27e20f12a14f709bc8bd5c206) (thanks @rom1504)
+* [Bump @types/node from 18.16.13 to 20.2.1 (#64)](https://github.com/PrismarineJS/prismarine-entity/commit/887737f531d89b25e045c4f0db4ec66497eba9f8) (thanks @dependabot[bot])
+* [Add missing type (#55)](https://github.com/PrismarineJS/prismarine-entity/commit/87a94dbaf698497f56968efbb396c3692431ae6f) (thanks @sefirosweb)
+* [deprecate objectType and mobType (#53)](https://github.com/PrismarineJS/prismarine-entity/commit/e3aadc7e51dccc645d81825aa0bd40b3be88cb05) (thanks @Epirito)
+* [Update package.json (#52)](https://github.com/PrismarineJS/prismarine-entity/commit/1156c9b9ae76b3e82ea57348c0f4e0cbdcb6216a) (thanks @Epirito)
+
+### 2.2.0
+
+* mcData to registry refactoring (step towards #2450)
+
 ### 2.1.1
 
 * Update mcdata

package/index.d.ts

@@ -41,6 +41,7 @@ declare module 'prismarine-entity' {
         health?: number;
         food?: number;
         foodSaturation?: number;
+        elytraFlying?: boolean
         player?: object;
         effects: Effect[];
         setEquipment(index: number, item: Item): void;
@@ -48,5 +49,5 @@ declare module 'prismarine-entity' {
         getDroppedItem(): Item | null;
     }
 
-    export type EntityType = 'player' | 'mob' | 'object' | 'global' | 'orb' | 'other';
+    export type EntityType = 'player' | 'mob' | 'object' | 'global' | 'orb' | 'projectile'| 'hostile' | 'other';
 }

package/index.js

@@ -1,10 +1,10 @@
 const Vec3 = require('vec3').Vec3
 const EventEmitter = require('events').EventEmitter
 
-module.exports = (version) => {
-  const ChatMessage = require('prismarine-chat')(version)
-  const Item = require('prismarine-item')(version)
-  const mcData = require('minecraft-data')(version)
+module.exports = (registryOrVersion) => {
+  const registry = typeof registryOrVersion === 'string' ? require('prismarine-registry')(registryOrVersion) : registryOrVersion
+  const ChatMessage = require('prismarine-chat')(registry)
+  const Item = require('prismarine-item')(registry)
   class Entity extends EventEmitter {
     constructor (id) {
       super()
@@ -24,6 +24,26 @@ module.exports = (version) => {
       this.metadata = []
     }
 
+    get mobType () {
+      printMobTypeWarning()
+      return this.displayName
+    }
+
+    set mobType (name) {
+      printMobTypeWarning()
+      this.displayName = name
+    }
+
+    get objectType () {
+      printObjectTypeWarning()
+      return this.displayName
+    }
+
+    set objectType (name) {
+      printObjectTypeWarning()
+      this.displayName = name
+    }
+
     setEquipment (index, item) {
       this.equipment[index] = item
       this.heldItem = this.equipment[0]
@@ -41,9 +61,15 @@ module.exports = (version) => {
       if (this.name !== 'item' && this.name !== 'Item' && this.name !== 'item_stack') {
         return null // not a dropped item
       }
-      return Item.fromNotch(this.metadata[mcData.supportFeature('metadataIxOfItem')])
+      return Item.fromNotch(this.metadata[registry.supportFeature('metadataIxOfItem')])
     }
   }
 
   return Entity
 }
+function printMobTypeWarning () {
+  console.log('Warning: entity.mobType is deprecated. Use entity.displayName instead')
+}
+function printObjectTypeWarning () {
+  console.log('Warning: entity.objectType is deprecated. Use entity.displayName instead')
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismarine-entity",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "Represent a minecraft entity",
   "main": "index.js",
   "types": "index.d.ts",
@@ -13,9 +13,9 @@
     "url": "https://github.com/PrismarineJS/prismarine-entity.git"
   },
   "dependencies": {
-    "minecraft-data": "^3.0.0",
     "prismarine-chat": "^1.4.1",
     "prismarine-item": "^1.11.2",
+    "prismarine-registry": "^1.4.0",
     "vec3": "^0.1.4"
   },
   "keywords": [
@@ -29,8 +29,8 @@
     "url": "https://github.com/PrismarineJS/prismarine-entity/issues"
   },
   "devDependencies": {
-    "@types/node": "^17.0.4",
+    "@types/node": "^20.2.1",
     "prismarine-entity": "file:.",
-    "standard": "^16.0.1"
+    "standard": "^17.0.0"
   }
 }