prismarine-entity 1.2.0 → 2.1.1

package/README.md

@@ -7,11 +7,10 @@ Represent a minecraft entity
 ## Usage
 
 ```js
-var Entity=require("prismarine-entity");
+const Entity = require("prismarine-entity")('1.8.9')
 
-var entity=new Entity(0);
-
-console.log(entity);
+const entity = new Entity(0)
+console.log(entity)
 ```
 
 ## API
@@ -97,6 +96,16 @@ Equivalent to `entity.equipment[0]`.
 
 See http://wiki.vg/Entities#Entity_Metadata_Format for more details.
 
+#### entity.noClip
+
+#### entity.vehicle
+
+Entity that this entity is riding on
+
+#### entity.passenger
+
+Entity that is riding on this entity
+
 #### entity.health
 
 The health of the player, default: 20
@@ -109,8 +118,30 @@ The food of the player, default: 20
 
 The player
 
+#### entity.getCustomName()
+
+returns a `prismarine-chat` ChatMessage object for the name of the entity or null if there isn't one
+
+#### entity.getDroppedItem()
+
+returns a `prismarine-item` Item object for the dropped item, if this is a dropped item, or it will return null
+
 ## History
 
+### 2.1.1
+
+* Update mcdata
+
+### 2.1.0
+
+* Adds Entity#getDroppedItem
+
+### 2.0.0
+
+* require mcversion in constructor
+* add Entity#getCustomName()
+* Add attributes for entity entity collision calculation (thanks @O-of)
+
 ### 1.2.0
 
 * Add food saturation to typings

package/example.js

@@ -1,4 +1,4 @@
-const Entity = require('./')
+const Entity = require('prismarine-entity')('1.8.9')
 
 const entity = new Entity(0)
 

package/index.d.ts

@@ -5,6 +5,7 @@
 import {EventEmitter} from 'events';
 import { Vec3 } from 'vec3';
 import { Item } from 'prismarine-item';
+import { ChatMessage } from 'prismarine-chat';
 
 declare module 'prismarine-entity' {
     export interface Effect {
@@ -17,6 +18,7 @@ declare module 'prismarine-entity' {
         constructor(id: number);
         id: number;
         type: EntityType;
+        uuid?: string;
         username?: string;
         mobType?: string;
         displayName?: string;
@@ -42,6 +44,8 @@ declare module 'prismarine-entity' {
         player?: object;
         effects: Effect[];
         setEquipment(index: number, item: Item): void;
+        getCustomName(): ChatMessage | null;
+        getDroppedItem(): Item | null;
     }
 
     export type EntityType = 'player' | 'mob' | 'object' | 'global' | 'orb' | 'other';

package/index.js

@@ -1,30 +1,49 @@
 const Vec3 = require('vec3').Vec3
-const util = require('util')
 const EventEmitter = require('events').EventEmitter
 
-module.exports = Entity
+module.exports = (version) => {
+  const ChatMessage = require('prismarine-chat')(version)
+  const Item = require('prismarine-item')(version)
+  const mcData = require('minecraft-data')(version)
+  class Entity extends EventEmitter {
+    constructor (id) {
+      super()
+      this.id = id
+      this.position = new Vec3(0, 0, 0)
+      this.velocity = new Vec3(0, 0, 0)
+      this.yaw = 0
+      this.pitch = 0
+      this.onGround = true
+      this.height = 0
+      this.width = 0
+      this.effects = {}
+      // 0 = held item, 1-4 = armor slot
+      this.equipment = new Array(5)
+      this.heldItem = this.equipment[0] // shortcut to equipment[0]
+      this.isValid = true
+      this.metadata = []
+    }
 
-function Entity (id) {
-  EventEmitter.call(this)
-  this.id = id
-  this.type = null
-  this.position = new Vec3(0, 0, 0)
-  this.velocity = new Vec3(0, 0, 0)
-  this.yaw = 0
-  this.pitch = 0
-  this.onGround = true
-  this.height = 0
-  this.width = 0
-  this.effects = {}
-  // 0 = held item, 1-4 = armor slot
-  this.equipment = new Array(5)
-  this.heldItem = this.equipment[0] // shortcut to equipment[0]
-  this.isValid = true
-  this.metadata = []
-}
-util.inherits(Entity, EventEmitter)
+    setEquipment (index, item) {
+      this.equipment[index] = item
+      this.heldItem = this.equipment[0]
+    }
+
+    getCustomName () {
+      const name = this.metadata[2]
+      if (name === undefined) {
+        return null
+      }
+      return ChatMessage.fromNotch(name)
+    }
+
+    getDroppedItem () {
+      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')])
+    }
+  }
 
-Entity.prototype.setEquipment = function (index, item) {
-  this.equipment[index] = item
-  this.heldItem = this.equipment[0]
+  return Entity
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prismarine-entity",
-  "version": "1.2.0",
+  "version": "2.1.1",
   "description": "Represent a minecraft entity",
   "main": "index.js",
   "types": "index.d.ts",
@@ -13,6 +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",
     "vec3": "^0.1.4"
   },
   "keywords": [
@@ -26,8 +29,8 @@
     "url": "https://github.com/PrismarineJS/prismarine-entity/issues"
   },
   "devDependencies": {
-    "@types/node": "^15.0.1",
-    "prismarine-item": "^1.4.0",
+    "@types/node": "^17.0.4",
+    "prismarine-entity": "file:.",
     "standard": "^16.0.1"
   }
 }