Namespace: Entity

Methods

staticEntity.addEffect(entity, effectId, duration, amplification, ambient, showParticles)

entity.jsdoc, line 8

Add a potion effect with the specified effectId to the specified entity.

Name	Type	Description
entity	Object	the entity to add the effect to
effectId	int	the MobEffect to add
duration	int	the duration of the effect in ticks (1 second = 20 ticks)
amplification	int	the amplification level of the effect
ambient	boolean	???
showParticles	boolean	show particle effects if true, otherwise false

• MobEffect
• get more info on `amplification`
• figure out what `ambient` is

Example

// give that poisonous look
var entity = Player.getPointedEntity(),
var effect = MobEffect.poison;

// to calculate duration, multiply the number of seconds by 20
// (e.g., 30 seconds * 20 ticks/second = 600 ticks)
var duration = 600;

Entity.addEffect(entity, effect, duration, 0, false, true);

staticEntity.getAll(){Array.<long>}

entity.jsdoc, line 39

Return a list of all entity objects in the current world.

Returns:

Type	Description
Array.<long>	all entity objects currently in the game

Example

credit: Zhuowei Zhang

// triggered via a custom command (/removeall)
function procCmd(cmd) {
  if (cmd === "removeall") {
    var entitiesList = Entity.getAll();
    for (var i = 0; i < entitiesList.length; i++) {

      //skip players, otherwise Minecraft glitches
      if (Player.isPlayer(entitiesList[i])) {
        continue;
      }

      Entity.remove(entitiesList[i]);
    }
  } else {
    return;
  }
}

staticEntity.getAnimalAge(entity){int}

entity.jsdoc, line 70

Return the age of a mob. Only works for animals and zombies/skeletons/pigmen.

Name	Type	Description
entity	long	the native entity id of the animal

Returns:

Type	Description
int	the animal's age

Example

// code here

staticEntity.getArmor(entity, armorSlot){int}

entity.jsdoc, line 86

Returns the Item ID of the armor in the given ArmorType slot.

Name	Type	Description
entity	long	the native entity id of the player/mob to check
armorSlot	int	the ArmorType to check

Returns:

Type	Description
int	the Item ID of the armor in the given slot

Example

// what's that mob wearing?
var ent = Player.getPointedEntity();
var eid = Entity.getEntityTypeId(ent);
if (eid >= 10 && eid <= 90) {
  for (var e in EntityType) {
    if (EntityType[e] === eid) {
      var armor = [];
      var msg = "";
      // check each armor slot
      for (var t in ArmorType) {
        var slot = Item.getName(Entity.getArmor(ent, t)) || "";
        if (slot !== "") {
          armor.push(slot);
        }
        if (armor[0]) {
          msg = "The mob is wearing: " + armor.toString();
        }
      }
      clientMessage(msg);
    }
  }
}

staticEntity.getArmorDamage()

entity.jsdoc, line 123

desc

Example

// code here

staticEntity.getEntityTypeId()

entity.jsdoc, line 135

desc

Example

// code here

staticEntity.getHealth()

entity.jsdoc, line 147

desc

Example

// code here

staticEntity.getItemEntityCount()

entity.jsdoc, line 159

desc

Example

// code here

staticEntity.getItemEntityData()

entity.jsdoc, line 171

desc

Example

// code here

staticEntity.getItemEntityId()

entity.jsdoc, line 183

desc

Example

// code here

staticEntity.getMaxHealth()

entity.jsdoc, line 195

desc

Example

// code here

staticEntity.getMobSkin()

entity.jsdoc, line 207

desc

Example

// code here

staticEntity.getNameTag()

entity.jsdoc, line 219

desc

Example

// code here

staticEntity.getPitch(entity){double}

entity.jsdoc, line 231

Return the up/down head rotation of the given entity (range: -90 to 90).

Name	Type	Default	Description
entity	long	Player	optional the native entity id to query

Returns:

Type	Description
double	the pitch value

• Entity.getYaw for a more detailed example

Example

// no shoe gazing
var pitch = Entity.getPitch();
if (pitch < -30) {
  clientMessage("Keep your head up!!");
}

staticEntity.getRenderType()

entity.jsdoc, line 252

desc

Example

// code here

staticEntity.getRider()

entity.jsdoc, line 264

desc

Example

// code here

staticEntity.getRiding()

entity.jsdoc, line 276

desc

Example

// code here

staticEntity.getUniqueId()

entity.jsdoc, line 288

desc

Example

// code here

staticEntity.getVelX()

entity.jsdoc, line 300

desc

Example

// code here

staticEntity.getVelY()

entity.jsdoc, line 312

desc

Example

// code here

staticEntity.getVelZ()

entity.jsdoc, line 324

desc

Example

// code here

staticEntity.getX()

entity.jsdoc, line 336

desc

Example

// code here

staticEntity.getY()

entity.jsdoc, line 348

desc

Example

// code here

staticEntity.getYaw(entity){double}

entity.jsdoc, line 360

return the left/right head rotation of the given entity (range: -∞ to ∞)

Name	Type	Default	Description
entity	long	Player	optional the native entity id to query

Returns:

Type	Description
double	the yaw value

Example

Based on Anti's DebugPE mod

// determine player's cardinal or intermediate direction
function getDirection() {
  var player = Player.getEntity();
  var yaw = Entity.getYaw(player);
  var pitch = Entity.getPitch(player);
  var direction;

  // adjust rotation for yaw < 0 || yaw >= 360
  if (yaw < 0) {
    Entity.setRot(player, yaw + 360, pitch);
  } else if (yaw >= 360) {
    Entity.setRot(player, yaw - 360, pitch);
  }

  // determine direction with fuzzy ranges
  if ((yaw >= 337.5 && yaw < 360) || (yaw >= 0 && yaw < 22.5)) {
    direction = "West";
  } else if (yaw >= 22.5 && yaw < 67.5) {
    direction = "North West";
  } else if (yaw >= 67.5 && yaw < 112.5) {
    direction = "North";
  } else if (yaw >= 112.5 && yaw < 157.5) {
    direction = "North East";
  } else if (yaw >= 157.5 && yaw < 202.5) {
    direction = "East";
  } else if (yaw >= 202.5 && yaw < 247.5) {
    direction = "South East";
  } else if (yaw >= 247.5 && yaw < 292.5) {
    direction = "South";
  } else if (yaw >= 292.5 && yaw < 337.5) {
    direction = "South West";
  }
  return direction;
}

// if you die watching the sun set, this should print "West" :-)
clientMessage(getDirection());

staticEntity.getZ()

entity.jsdoc, line 413

desc

Example

// code here

staticEntity.isSneaking()

entity.jsdoc, line 425

desc

Example

// code here

staticEntity.remove()

entity.jsdoc, line 437

desc

Example

// code here

staticEntity.removeAllEffects()

entity.jsdoc, line 449

desc

Example

// code here

staticEntity.removeEffect()

entity.jsdoc, line 461

desc

Example

// code here

staticEntity.rideAnimal()

entity.jsdoc, line 473

desc

Example

// code here

staticEntity.setAnimalAge()

entity.jsdoc, line 485

desc

Example

// code here

staticEntity.setArmor()

entity.jsdoc, line 497

desc

Example

// code here

staticEntity.setCape()

entity.jsdoc, line 509

desc

Example

// code here

staticEntity.setCarriedItem()

entity.jsdoc, line 521

desc

Example

// code here

staticEntity.setCollisionSize()

entity.jsdoc, line 533

desc

Example

// code here

staticEntity.setFireTicks()

entity.jsdoc, line 545

desc

Example

// code here

staticEntity.setHealth()

entity.jsdoc, line 557

desc

Example

// code here

staticEntity.setMaxHealth()

entity.jsdoc, line 569

desc

Example

// code here

staticEntity.setMobSkin(id, skin)

entity.jsdoc, line 581

Set the skin image for a valid MCPE entity id.

Name	Type	Description
id	int	the entity ID (see: EntityType)
skin	string	the skin image path (usually an image found in the ../assets/images folder of the MCPE apk)

Example

// make yourself look like a creeper
Entity.setMobSkin(Player.getEntity(), "mob/creeper.png");

staticEntity.setNameTag()

entity.jsdoc, line 597

desc

Example

// code here

staticEntity.setPosition()

entity.jsdoc, line 609

desc

Example

// code here

staticEntity.setPositionRelative()

entity.jsdoc, line 621

desc

Example

// code here

staticEntity.setRenderType()

entity.jsdoc, line 633

desc

Example

// code here

staticEntity.setRot(entity, yaw, pitch)

entity.jsdoc, line 645

Set the rotation of the specified entity's head to the specified yaw and pitch. If attackHook is not used, Player.getEntity() should be used as the entity parameter.

Name	Type	Description
entity	long	the target entity that will have its head rotation modified
yaw	double	the desired yaw of the entity
pitch	double	the desired pitch of the entity

• getYaw for a more detailed example

Example

// the exorcist
var y = 0;
while (y <= 360) {
  setRot(Player.getEntity(), y, 0);
  y++;
}

staticEntity.setSneaking()

entity.jsdoc, line 670

desc

Example

// code here

staticEntity.setVelX(entity, velocity)

entity.jsdoc, line 682

Set the specified entity's velocity along the X axis.

Name	Type	Description
entity	long	the target entity
velocity	double	the desired velocity

Example

credit: Zhuowei Zhang

// jetpack fun time
var playerDir = [0, 0, 0];
var DEG_TO_RAD = Math.PI / 180;
var playerFlySpeed = 1;

function modTick() {
  if (Player.getCarriedItem() == 280) {
    jetpackTick();
  }
}
function jetpackTick() {
  toDirectionalVector(playerDir, (Player.getYaw() + 90) * DEG_TO_RAD, Player.getPitch() * DEG_TO_RAD * -1);
  var player = Player.getEntity();
  Entity.setVelX(player, playerFlySpeed * playerDir[0]);
  Entity.setVelY(player, playerFlySpeed * playerDir[1]);
  Entity.setVelZ(player, playerFlySpeed * playerDir[2]);
}
function toDirectionalVector(vector, yaw, pitch) {
  // see: http://stackoverflow.com/questions/1568568/how-to-convert-euler-angles-to-directional-vector
  vector[0] = Math.cos(yaw) * Math.cos(pitch);
  vector[1] = Math.sin(pitch);
  vector[2] = Math.sin(yaw) * Math.cos(pitch);
}

staticEntity.setVelY(entity, velocity)

entity.jsdoc, line 720

Set the specified entity's velocity along the Y axis.

Name	Type	Description
entity	long	the target entity
velocity	double	the desired velocity

• See example at Entity.setVelX

staticEntity.setVelZ(entity, velocity)

entity.jsdoc, line 733

Set the specified entity's velocity along the Z axis.

Name	Type	Description
entity	long	the target entity
velocity	double	the desired velocity

• See example at Entity.setVelX

staticEntity.spawnMob(x, y, z, id, skin)

entity.jsdoc, line 746

Spawn a valid MCPE entity with the specified id at the given x, y, and z coordinates using the specified skin image.

Name	Type	Description
x	double	the x coordinate
y	double	the y coordinate
z	double	the z coordinate
id	int	the entity ID (see: EntityType)
skin	string	the skin image path (an image found in the ../assets/images folder of the MCPE apk)

• Level.spawnMob, bl_spawnMob

Example

// spawn a skeleton
Entity.spawnMob(152, 48, 73, EntityType.SKELETON, "mob/skeleton.png");