Package org.bukkit.entity

Interface Allay

All Superinterfaces:

Attributable, CommandSender, Creature, Damageable, Entity, InventoryHolder, LivingEntity, Lootable, Metadatable, Mob, Nameable, Permissible, PersistentDataHolder, ProjectileSource, ServerOperator

public interface Allay
extends Creature, InventoryHolder

An Allay.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
boolean	canDuplicate()	Gets if the allay can duplicate.
Allay	duplicateAllay()	This make the current allay duplicate itself without dance or item necessary.
long	getDuplicationCooldown()	Gets the cooldown for duplicating the allay.
Location	getJukebox()	Gets the jukebox the allay is set to dance to.
boolean	isDancing()	Gets if the allay is dancing.
void	resetDuplicationCooldown()	Reset the cooldown for duplication.
void	setCanDuplicate(boolean canDuplicate)	Sets if the allay can duplicate.
void	setDuplicationCooldown(long cooldown)	Sets the cooldown before the allay can duplicate again.
void	startDancing()	Force sets the dancing status of the allay.
void	startDancing(Location location)	Causes the allay to start dancing because of the provided jukebox location.
void	stopDancing()	Makes the allay stop dancing.

Methods inherited from interface org.bukkit.attribute.Attributable

getAttribute

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface org.bukkit.entity.Damageable

damage, damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, copy, copy, createSnapshot, eject, getAsString, getBoundingBox, getEntityId, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isFrozen, isGlowing, isInsideVehicle, isInvulnerable, isInWater, isInWorld, isOnGround, isPersistent, isSilent, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, spigot, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.inventory.InventoryHolder

getInventory

Methods inherited from interface org.bukkit.entity.LivingEntity

addPotionEffect, addPotionEffect, addPotionEffects, attack, canBreatheUnderwater, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getCanPickupItems, getCategory, getCollidableExemptions, getDeathSound, getDrinkingSound, getEatingSound, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getFallDamageSound, getFallDamageSoundBig, getFallDamageSoundSmall, getHurtSound, getItemInUse, getItemInUseTicks, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoActionTicks, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getTargetBlock, getTargetBlockExact, getTargetBlockExact, hasAI, hasLineOfSight, hasPotionEffect, isClimbing, isCollidable, isGliding, isInvisible, isLeashed, isRiptiding, isSleeping, isSwimming, playHurtAnimation, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setCanPickupItems, setCollidable, setGliding, setInvisible, setItemInUseTicks, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoActionTicks, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setSwimming, swingMainHand, swingOffHand

Methods inherited from interface org.bukkit.loot.Lootable

getLootTable, getSeed, setLootTable, setSeed

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.entity.Mob

getAmbientSound, getTarget, isAware, setAware, setTarget

Methods inherited from interface org.bukkit.Nameable

getCustomName, setCustomName

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

launchProjectile, launchProjectile

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Method Details

canDuplicate

boolean canDuplicate()

Gets if the allay can duplicate.
Note: Duplication is based when the getDuplicationCooldown() its lower than zero.

Returns:

if the allay can duplicate itself.

setCanDuplicate

void setCanDuplicate(boolean canDuplicate)

Sets if the allay can duplicate.
Note: this value can be overridden later by getDuplicationCooldown() if is lower than zero. You can also use setDuplicationCooldown(long) to allow the allay to duplicate

Parameters:

canDuplicate - if the allay can duplicate itself

getDuplicationCooldown

long getDuplicationCooldown()

Gets the cooldown for duplicating the allay.

Returns:

the time in ticks when allay can duplicate

setDuplicationCooldown

void setDuplicationCooldown(long cooldown)

Sets the cooldown before the allay can duplicate again.

Parameters:

cooldown - the cooldown, use a negative number to deny allay to duplicate again.

resetDuplicationCooldown

void resetDuplicationCooldown()

Reset the cooldown for duplication. This will set the cooldown ticks to the same value as is set after an Allay has duplicated.

isDancing

boolean isDancing()

Gets if the allay is dancing.

Returns:

True if it is dancing, false otherwise.

startDancing

void startDancing(@NotNull
 Location location)

Causes the allay to start dancing because of the provided jukebox location.

Parameters:

location - the location of the jukebox

Throws:

IllegalArgumentException - if the block at the location is not a jukebox

startDancing

void startDancing()

Force sets the dancing status of the allay.
Note: This method forces the allay to dance, ignoring any nearby jukebox being required.

stopDancing

void stopDancing()

Makes the allay stop dancing.

duplicateAllay

@Nullable
Allay duplicateAllay()

This make the current allay duplicate itself without dance or item necessary. Note: this will fire a CreatureSpawnEvent

Returns:

the new entity Allay or null if the spawn was cancelled

getJukebox

@Nullable
Location getJukebox()

Gets the jukebox the allay is set to dance to.

Returns:

the location of the jukebox to dance if it exists