prismarine-entity


Represent a minecraft entity

Usage

``js
const Entity = require("prismarine-entity")('1.8.9')

const entity = new Entity(0)
console.log(entity)
`

API

$3

Entities represent players, mobs, and objects.

#### entity.id

#### entity.type

Choices:

* player
* mob
* object
* global - lightning
* orb - experience orb.
* other - introduced with a recent Minecraft update and not yet recognized or used by a third-party mod

#### entity.username

If the entity type is player, this field will be set.

#### entity.mobType

If the entity type is mob, this field will be set.

#### entity.displayName

Field set for mob and object. A long name in multiple words.

#### entity.entityType

Field set for mob and object. The numerical type of the entity (1,2,...)

#### entity.kind

Field set for mob and object. The kind of entity (for example Hostile mobs, Passive mobs, NPCs).

#### entity.name

Field set for mob and object. A short name for the entity.

#### entity.objectType

If the entity type is object, this field will be set.

#### entity.count

If the entity type is orb, this field will be how much experience you
get from collecting the orb.

#### entity.position

#### entity.velocity

#### entity.yaw

#### entity.pitch

#### entity.height

#### entity.width

#### entity.onGround

#### 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

Equivalent to entity.equipment[0].

#### entity.metadata

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

#### entity.food

The food of the player, default: 20

#### entity.elytraFlying

Whether or not the entity is elytra flying.

#### entity.player

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

$3

* add Entity.passengers and Entity.vehicle (#75) (thanks @qwqtoday)
* Bump @types/node from 20.14.15 to 22.2.0 (#80) (thanks @dependabot[bot])

$3

* use getter for .heldItem` (#73) (thanks @szdytom)

$3

* Use console.trace instead of console.log for deprecation message (#71) (thanks @extremeheat)

$3

* Add default elytra flying value (#69) (thanks @lkwilson)
* Fix equipment documentation for other versions (#67) (thanks @IceTank)
* Add command gh workflow allowing to use release command in comments (#66) (thanks @rom1504)
* Update to node 18.0.0 (#65) (thanks @rom1504)
* Bump @types/node from 18.16.13 to 20.2.1 (#64) (thanks @dependabot[bot])
* Add missing type (#55) (thanks @sefirosweb)
* deprecate objectType and mobType (#53) (thanks @Epirito)
* Update package.json (#52) (thanks @Epirito)

$3

* mcData to registry refactoring (step towards #2450)

$3

* Update mcdata

$3

* Adds Entity#getDroppedItem

$3

* require mcversion in constructor
* add Entity#getCustomName()
* Add attributes for entity entity collision calculation (thanks @O-of)

$3

* Add food saturation to typings
* Add id to typings
* Add effects to typings

$3

* Added entity width property

$3

* typescript definitions (thanks @IdanHo)

$3

* extend EventEmitter

$3

* Import from mineflayer