Interface Allay

All Superinterfaces:
Attributable, net.kyori.adventure.audience.Audience, CommandSender, Creature, Damageable, DataComponentView, Entity, Frictional, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, InventoryHolder, Leashable, LivingEntity, Lootable, Metadatable, Mob, Nameable, Permissible, PersistentDataHolder, PersistentDataViewHolder, net.kyori.adventure.pointer.Pointered, ProjectileSource, ServerOperator, net.kyori.adventure.sound.Sound.Emitter, net.kyori.adventure.sound.Sound.Source.Provider
public interface Allay extends Creature, InventoryHolder
An Allay.
Since:
1.19

  • 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.
      Since:
      1.19.2

    • 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
      Since:
      1.19.2

    • getDuplicationCooldown

      long getDuplicationCooldown()
      Gets the cooldown for duplicating the allay.
      Returns:
      the time in ticks when allay can duplicate
      Since:
      1.19.2

    • 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.
      Since:
      1.19.2

    • 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.
      Since:
      1.19.2

    • isDancing

      boolean isDancing()
      Gets if the allay is dancing.
      Returns:
      True if it is dancing, false otherwise.
      Since:
      1.19.2

    • startDancing

      void startDancing(@NotNull @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
      Since:
      1.19.2

    • 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.
      Since:
      1.19.2

    • stopDancing

      void stopDancing()
      Makes the allay stop dancing.
      Since:
      1.19.2

    • duplicateAllay

      @Nullable @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
      Since:
      1.19.2

    • getJukebox

      @Nullable @Nullable Location getJukebox()
      Gets the jukebox the allay is set to dance to.
      Returns:
      the location of the jukebox to dance if it exists
      Since:
      1.19.2