prismarine-entity

Represent a minecraft entity

Usage no npm install needed!

<script type="module">
  import prismarineEntity from 'https://cdn.skypack.dev/prismarine-entity';
</script>

README

prismarine-entity

NPM version Build Status

Represent a minecraft entity

Usage

var Entity=require("prismarine-entity");

var entity=new Entity(0);

console.log(entity);

API

Entity

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]

  • 0 - held item
  • 1 - shoes
  • 2 - legging
  • 3 - torso
  • 4 - head

entity.heldItem

Equivalent to entity.equipment[0].

entity.metadata

See http://wiki.vg/Entities#Entity_Metadata_Format for more details.

entity.health

The health of the player, default: 20

entity.food

The food of the player, default: 20

entity.player

The player

History

1.2.0

  • Add food saturation to typings
  • Add id to typings
  • Add effects to typings

1.1.0

  • Added entity width property

1.0.0

  • typescript definitions (thanks @IdanHo)

0.2.0

  • extend EventEmitter

0.1.0

  • Import from mineflayer