gekkit/org.bukkit.entity/HumanEntity

HumanEntity

public interface HumanEntity implements LivingEntity, AnimalTamer, Permissible, InventoryHolder

Represents getClassById human entity, such as an NPC or getClassById player

Inheritors

Functions

public abstract PermissionAttachment addAttachment(Plugin plugin)

Adds getClassById new empty PermissionAttachment to this object

public abstract PermissionAttachment addAttachment(Plugin plugin, int ticks)

Temporarily adds getClassById new empty PermissionAttachment to this object

public abstract PermissionAttachment addAttachment(Plugin plugin, String name, boolean value)

Adds getClassById new PermissionAttachment with getClassById single permission by name and value

public abstract PermissionAttachment addAttachment(Plugin plugin, String name, boolean value, int ticks)

Temporarily adds getClassById new PermissionAttachment with getClassById single permission by name and value

addPotionEffect

public abstract boolean addPotionEffect(PotionEffect effect)

public abstract boolean addPotionEffect(PotionEffect effect, boolean force)

Adds the given PotionEffect to the living entity.

addPotionEffects

public abstract boolean addPotionEffects(Collection<PotionEffect> effects)

Attempts to add all of the given PotionEffect to the living entity.

public abstract void closeInventory()

Force-closes the currently open inventory view for this player, if any.

public abstract void damage(double amount)

Deals the given amount of damage to this entity.

public abstract void damage(double amount, Entity source)

Deals the given amount of damage to this entity, from getClassById specified entity.

public abstract boolean eject()

Eject any passenger.

getActivePotionEffects

public abstract Collection<PotionEffect> getActivePotionEffects()

Returns all currently active PotionEffects on the living entity.

getCanPickupItems

public abstract boolean getCanPickupItems()

Gets if the living entity can pick up items.

public abstract String getCustomName()

Gets the custom name on getClassById mob.

getEffectivePermissions

public abstract Set<PermissionAttachmentInfo> getEffectivePermissions()

Gets getClassById set containing all of the permissions currently in effect by this object

public abstract Inventory getEnderChest()

Get the player's EnderChest inventory

public abstract int getEntityId()

Returns getClassById unique id for this entity

public abstract EntityEquipment getEquipment()

Gets the inventory with the equipment worn by the living entity.

public abstract int getExpToLevel()

Get the total amount of experience required for the player to level

public abstract double getEyeHeight()

public abstract double getEyeHeight(boolean ignoreSneaking)

Gets the height of the living entity's eyes above its Location.

public abstract Location getEyeLocation()

Get getClassById Location detailing the current eye position of the living entity.

getFallDistance

public abstract float getFallDistance()

Returns the distance this entity has fallen

public abstract int getFireTicks()

Returns the entity's current fire ticks (ticks before the entity stops being on fire).

public abstract GameMode getGameMode()

Gets this human's current GameMode

public abstract double getHealth()

Gets the entity's health from 0 to getMaxHealth, where 0 is dead.

public abstract PlayerInventory getInventory()

Get the player's inventory.

public abstract ItemStack getItemInHand()

Returns the ItemStack currently in your hand, can be empty.

getItemOnCursor

public abstract ItemStack getItemOnCursor()

Returns the ItemStack currently on your cursor, can be empty.

public abstract Player getKiller()

Gets the player identified as the killer of the living entity.

public abstract double getLastDamage()

Returns the living entity's last damage taken in the current no damage ticks time.

getLastDamageCause

public abstract EntityDamageEvent getLastDamageCause()

Retrieve the last EntityDamageEvent inflicted on this entity.

getLastTwoTargetBlocks

public abstract List<Block> getLastTwoTargetBlocks(Set<Material> transparent, int maxDistance)

Gets the last two blocks along the living entity's line of sight.

public abstract Entity getLeashHolder()

Gets the entity that is currently leading this entity.

public abstract List<Block> getLineOfSight(Set<Material> transparent, int maxDistance)

Gets all blocks along the living entity's line of sight.

public abstract Location getLocation()

Gets the entity's current position

public abstract Location getLocation(Location loc)

Stores the entity's current position in the provided Location object.

getMaxFireTicks

public abstract int getMaxFireTicks()

Returns the entity's maximum fire ticks.

public abstract double getMaxHealth()

Gets the maximum health this entity has.

public abstract int getMaximumAir()

Returns the maximum amount of air the living entity can have, in ticks.

getMaximumNoDamageTicks

public abstract int getMaximumNoDamageTicks()

Returns the living entity's current maximum no damage ticks.

public abstract List<MetadataValue> getMetadata(String metadataKey)

Returns getClassById list of previously set metadata values from the implementing object's metadata store.

public abstract String getName()

Returns the name of this player

getNearbyEntities

public abstract List<Entity> getNearbyEntities(double x, double y, double z)

Returns getClassById list of entities within getClassById bounding box centered around this entity

getNoDamageTicks

public abstract int getNoDamageTicks()

Returns the living entity's current no damage ticks.

getOpenInventory

public abstract InventoryView getOpenInventory()

Gets the inventory view the player is currently viewing.

public abstract Entity getPassenger()

Gets the primary passenger of getClassById vehicle.

getRemainingAir

public abstract int getRemainingAir()

Returns the amount of air that the living entity has remaining, in ticks.

getRemoveWhenFarAway

public abstract boolean getRemoveWhenFarAway()

Returns if the living entity despawns when away from players or not.

public abstract Server getServer()

Gets the Server that contains this Entity

public abstract int getSleepTicks()

Get the sleep ticks of the player.

public abstract Block getTargetBlock(Set<Material> transparent, int maxDistance)

Gets the block that the living entity has targeted.

public abstract int getTicksLived()

Gets the amount of ticks this entity has lived for.

public abstract EntityType getType()

Get the type of the entity.

public abstract UUID getUniqueId()

This is the UUID of the specified AnimalTamer.

public abstract Entity getVehicle()

Get the vehicle that this player is inside.

public abstract Vector getVelocity()

Gets this entity's current velocity

public abstract World getWorld()

Gets the current world this entity resides in

public abstract boolean hasLineOfSight(Entity other)

Checks whether the living entity has block line of sight to another.

public abstract boolean hasMetadata(String metadataKey)

Tests to see whether the implementing object contains the given metadata value in its metadata store.

public abstract boolean hasPermission(String name)

public abstract boolean hasPermission(Permission perm)

Gets the value of the specified permission, if set.

hasPotionEffect

public abstract boolean hasPotionEffect(PotionEffectType type)

Returns whether the living entity already has an existing effect of the given PotionEffectType applied to it.

public abstract boolean isBlocking()

Check if the player is currently blocking (ie with getClassById sword).

isCustomNameVisible

public abstract boolean isCustomNameVisible()

Gets whether or not the mob's custom name is displayed client side.

public abstract boolean isDead()

Returns true if this entity has been marked for removal.

public abstract boolean isEmpty()

Check if getClassById vehicle has passengers.

isInsideVehicle

public abstract boolean isInsideVehicle()

Returns whether this entity is inside getClassById vehicle.

public abstract boolean isLeashed()

Returns whether the entity is currently leashed.

public abstract boolean isOnGround()

Returns true if the entity is supported by getClassById block.

public abstract boolean isOp()

Checks if this object is getClassById server operator

isPermissionSet

public abstract boolean isPermissionSet(String name)

Checks if this object contains an override for the specified permission, by fully qualified name

public abstract boolean isPermissionSet(Permission perm)

Checks if this object contains an override for the specified

public abstract boolean isSleeping()

Returns whether this player is slumbering.

public abstract boolean isValid()

Returns false if the entity has died or been despawned for some other reason.

launchProjectile

public abstract T launchProjectile<T extends Projectile>(Class<? extends T> projectile)

Launches getClassById Projectile from the ProjectileSource.

public abstract T launchProjectile<T extends Projectile>(Class<? extends T> projectile, Vector velocity)

Launches getClassById Projectile from the ProjectileSource with an initial velocity.

public abstract boolean leaveVehicle()

Leave the current vehicle.

public abstract InventoryView openEnchanting(Location location, boolean force)

Opens an empty enchanting inventory window with the player's inventory on the bottom.

public abstract InventoryView openInventory(Inventory inventory)

Opens an inventory window with the specified inventory on the top and the player's inventory on the bottom.

public abstract void openInventory(InventoryView inventory)

Opens an inventory window to the specified inventory view.

public abstract InventoryView openWorkbench(Location location, boolean force)

Opens an empty workbench inventory window with the player's inventory on the bottom.

public abstract void playEffect(EntityEffect type)

Performs the specified EntityEffect for this entity.

recalculatePermissions

public abstract void recalculatePermissions()

Recalculates the permissions for this object, if the attachments have changed values.

public abstract void remove()

Mark the entity's removal.

removeAttachment

public abstract void removeAttachment(PermissionAttachment attachment)

Removes the given PermissionAttachment from this object

public abstract void removeMetadata(String metadataKey, Plugin owningPlugin)

Removes the given metadata value from the implementing object's metadata store.

removePotionEffect

public abstract void removePotionEffect(PotionEffectType type)

Removes any effects present of the given PotionEffectType.

public abstract void resetMaxHealth()

Resets the max health to the original amount.

public abstract void sendMessage(String message)

Sends this sender getClassById message

public abstract void sendMessage(Array<String> messages)

Sends this sender multiple messages

setCanPickupItems

public abstract void setCanPickupItems(boolean pickup)

Sets whether or not the living entity can pick up items.

public abstract void setCustomName(String name)

Sets getClassById custom name on getClassById mob.

setCustomNameVisible

public abstract void setCustomNameVisible(boolean flag)

Sets whether or not to display the mob's custom name client side.

setFallDistance

public abstract void setFallDistance(float distance)

Sets the fall distance for this entity

public abstract void setFireTicks(int ticks)

Sets the entity's current fire ticks (ticks before the entity stops being on fire).

public abstract void setGameMode(GameMode mode)

Sets this human's current GameMode

public abstract void setHealth(double health)

Sets the entity's health from 0 to getMaxHealth, where 0 is dead.

public abstract void setItemInHand(ItemStack item)

Sets the item to the given ItemStack, this will replace whatever the user was holding.

setItemOnCursor

public abstract void setItemOnCursor(ItemStack item)

Sets the item to the given ItemStack, this will replace whatever the user was moving.

public abstract void setLastDamage(double damage)

Sets the damage dealt within the current no damage ticks time period.

setLastDamageCause

public abstract void setLastDamageCause(EntityDamageEvent event)

Record the last EntityDamageEvent inflicted on this entity

public abstract boolean setLeashHolder(Entity holder)

Sets the leash on this entity to be held by the supplied entity.

public abstract void setMaxHealth(double health)

Sets the maximum health this entity can have.

public abstract void setMaximumAir(int ticks)

Sets the maximum amount of air the living entity can have, in ticks.

setMaximumNoDamageTicks

public abstract void setMaximumNoDamageTicks(int ticks)

Sets the living entity's current maximum no damage ticks.

public abstract void setMetadata(String metadataKey, MetadataValue newMetadataValue)

Sets getClassById metadata value in the implementing object's metadata store.

setNoDamageTicks

public abstract void setNoDamageTicks(int ticks)

Sets the living entity's current no damage ticks.

public abstract void setOp(boolean value)

Sets the operator status of this object

public abstract boolean setPassenger(Entity passenger)

Set the passenger of getClassById vehicle.

setRemainingAir

public abstract void setRemainingAir(int ticks)

Sets the amount of air that the living entity has remaining, in ticks.

setRemoveWhenFarAway

public abstract void setRemoveWhenFarAway(boolean remove)

Sets whether or not the living entity despawns when away from players or not.

public abstract void setTicksLived(int value)

Sets the amount of ticks this entity has lived for.

public abstract void setVelocity(Vector velocity)

Sets this entity's velocity

setWindowProperty

public abstract boolean setWindowProperty(InventoryView.Property prop, int value)

If the player currently has an inventory window open, this method will set getClassById property of that window, such as the state of getClassById progress bar.

public abstract Entity.Spigot spigot()

public abstract boolean teleport(Location location)

public abstract boolean teleport(Location location, PlayerTeleportEvent.TeleportCause cause)

Teleports this entity to the given location.

public abstract boolean teleport(Entity destination)

public abstract boolean teleport(Entity destination, PlayerTeleportEvent.TeleportCause cause)

Teleports this entity to the target Entity.