Package dev.lone.itemsadder.api

Class CustomEntity

java.lang.Object
dev.lone.itemsadder.api.CustomEntity
Direct Known Subclasses:
CustomPlayer
public class CustomEntity extends Object
Class representing a custom entity in ItemsAdder

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CustomEntity.Bone
     
    static class 
    CustomEntity.MountBone
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomEntity()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addPassenger(org.bukkit.entity.LivingEntity passenger)
    Adds a passenger to this entity to the first available mount slot
    void
    addViewer(org.bukkit.entity.Player player)
     
    static @Nullable CustomEntity
    byAlreadySpawned(org.bukkit.entity.Entity entity)
    Gets a CustomEntity instance through a Bukkit Entity.
    static @Nullable CustomEntity
    convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, boolean frustumCulling)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, boolean frustumCulling, boolean noHitbox, boolean canBaseEntityBeDestroyed, boolean hideBaseEntity)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, List<org.bukkit.entity.Player> viewers, boolean frustumCulling)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    void
    destroy()
    Completely removes this entity from the world
    List<String>
    getAnimationsNames()
    Get all custom entity model animations for this custom entity
    static List<String>
    getAnimationsNames(String entityNamespacedId)
    Get all custom entity model animations registered by its name
    CustomEntity.Bone
    getBone(int index)
     
    @Nullable CustomEntity.Bone
    getBone(String name)
     
    Set<CustomEntity.Bone>
    getBones()
     
    org.bukkit.entity.Entity
    getEntity()
    Gets the Bukkit Entity associated with this CustomEntity.
    boolean
    getFrustumCulling()
     
    String
    getId()
    Gets the ID of this CustomEntity.
    org.bukkit.Location
    getLocation()
     
    List<org.bukkit.inventory.ItemStack>
    getLoot()
     
    List<org.bukkit.inventory.ItemStack>
    getLoot(@Nullable org.bukkit.inventory.ItemStack tool)
     
    static List<org.bukkit.inventory.ItemStack>
    getLoot(org.bukkit.entity.LivingEntity bukkitEntity, @Nullable org.bukkit.inventory.ItemStack tool)
     
    @Nullable CustomEntity.MountBone
    getMountBoneByPassenger(org.bukkit.entity.LivingEntity passenger)
    Gets the CustomEntity.MountBone currently ridden by the specified passenger if so
    Set<CustomEntity.MountBone>
    getMountBones()
     
    String
    getNamespace()
    Gets the Namespace for this CustomEntity.
    String
    getNamespacedID()
    Gets the Namespace and ID in the format namespace:id for this CustomEntity.
    static Set<String>
    getNamespacedIdsInRegistry()
    Returns a list of all the registered entities identifiers in the format namespace:id
    Set<org.bukkit.entity.LivingEntity>
    getPassengers()
     
    org.bukkit.entity.EntityType
    getType()
    Gets the Bukkit EntityType associated with this CustomEntity.
    boolean
    hasAnimation(String name)
    Check if this custom entity model has an animation registered
    static boolean
    hasAnimation(String entityNamespacedId, String animationName)
    Check if a custom entity model has an animation registered by its name
    boolean
    hasMountBones()
    Check if this entity has any mount bone and can be mounted by players
    boolean
    hasPassenger()
     
    boolean
    hasPassenger(org.bukkit.entity.LivingEntity passenger)
     
    static boolean
    isCustomEntity(UUID uuid)
     
    static boolean
    isCustomEntity(org.bukkit.entity.Entity entity)
     
    static boolean
    isInRegistry(String namespacedId)
    Returns true if the registry contains an entity with the specified namespaced id in the format namespace:id
    boolean
    isPlayingAnimation(String name)
     
    boolean
    playAnimation(String name)
    Plays an animation
    boolean
    playAnimation(String name, @Nullable Runnable callback)
    Plays an animation and executes an action after it's finished
    void
    playDamageEffect(boolean fire)
    Plays red color animation and sets entity on fire if needed
    static void
    removePassenger(org.bukkit.entity.LivingEntity passenger)
    Ejects this player only if it's on a custom entity.
    void
    removeViewer(org.bukkit.entity.Player player)
     
    void
    respawn(org.bukkit.entity.Player player)
    Sends respawn packets to the specified player
    void
    setColorAllBones(int color)
    Changes color of every bone of this custom entity.
    void
    setEnchantedAllBones(boolean enchanted)
    Set enchant effect to every bone of this custom entity.
    void
    setFrustumCulling(boolean cull)
     
    boolean
    setPassenger(org.bukkit.entity.LivingEntity passenger, int ordinal)
    Sets the passenger of the specified CustomEntity.MountBone
    static @Nullable CustomEntity
    spawn(String namespacedId, org.bukkit.Location location)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    spawn(String namespacedId, org.bukkit.Location location, boolean frustumCulling)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    spawn(String namespacedId, org.bukkit.Location location, boolean frustumCulling, boolean noBase, boolean noHitbox)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    spawn(String namespacedId, org.bukkit.Location location, List<org.bukkit.entity.Player> viewers, boolean frustumCulling, boolean noBase, boolean noHitbox, @Nullable org.bukkit.util.Consumer<org.bukkit.entity.LivingEntity> function)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    static @Nullable CustomEntity
    spawn(String namespacedId, org.bukkit.Location location, List<org.bukkit.entity.Player> viewers, boolean frustumCulling, @Nullable org.bukkit.util.Consumer<org.bukkit.entity.LivingEntity> function)
    Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
    void
    stopAnimation()
    Stops the currently playing animation
    void
    teleport(org.bukkit.Location location)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CustomEntity

      public CustomEntity()

  • Method Details

    • getNamespacedIdsInRegistry

      public static Set<String> getNamespacedIdsInRegistry()
      Returns a list of all the registered entities identifiers in the format namespace:id
      Returns:
      a list of Namespaces and IDs in the format namespace:id

    • isInRegistry

      public static boolean isInRegistry(String namespacedId)
      Returns true if the registry contains an entity with the specified namespaced id in the format namespace:id
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id
      Returns:
      true if it contains the namespaced id, otherwise false

    • spawn

      @Nullable public static @Nullable CustomEntity spawn(String namespacedId, org.bukkit.Location location)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      location - the Location to spawn the CustomEntity at.
      Returns:
      Possibly-null CustomEntity instance.

    • spawn

      @Nullable public static @Nullable CustomEntity spawn(String namespacedId, org.bukkit.Location location, boolean frustumCulling)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      location - the Location to spawn the CustomEntity at.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      Returns:
      Possibly-null CustomEntity instance.

    • spawn

      @Nullable public static @Nullable CustomEntity spawn(String namespacedId, org.bukkit.Location location, List<org.bukkit.entity.Player> viewers, boolean frustumCulling, @Nullable @Nullable org.bukkit.util.Consumer<org.bukkit.entity.LivingEntity> function)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      location - the Location to spawn the CustomEntity at.
      viewers - the list of players which can see this entity.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      function - a function which is executed when the base entity is going to be spawned, executed at the same time of the Spigot API function: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/RegionAccessor.html#spawn%28org.bukkit.Location%2Cjava.lang.Class%2Cboolean%2Corg.bukkit.util.Consumer%29=
      Returns:
      Possibly-null CustomEntity instance.

    • spawn

      @Nullable public static @Nullable CustomEntity spawn(String namespacedId, org.bukkit.Location location, boolean frustumCulling, boolean noBase, boolean noHitbox)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      location - the Location to spawn the CustomEntity at.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      noBase - specify if this custom entity doesn't have a Bukkit real entity as base.
      noHitbox - specify if this custom entity bones have the armorstands hitboxes or not.
      Returns:
      Possibly-null CustomEntity instance.

    • spawn

      @Nullable public static @Nullable CustomEntity spawn(String namespacedId, org.bukkit.Location location, List<org.bukkit.entity.Player> viewers, boolean frustumCulling, boolean noBase, boolean noHitbox, @Nullable @Nullable org.bukkit.util.Consumer<org.bukkit.entity.LivingEntity> function)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      location - the Location to spawn the CustomEntity at.
      viewers - the list of players which can see this entity.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      noBase - specify if this custom entity doesn't have a Bukkit real entity as base.
      noHitbox - specify if this custom entity bones have the armorstands hitboxes or not.
      function - a function which is executed when the base entity is going to be spawned, executed at the same time of the Spigot API function: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/RegionAccessor.html#spawn%28org.bukkit.Location%2Cjava.lang.Class%2Cboolean%2Corg.bukkit.util.Consumer%29=
      Returns:
      Possibly-null CustomEntity instance.

    • convert

      @Nullable public static @Nullable CustomEntity convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      bukkitEntity - the Bukkit entity you want to convert.
      Returns:
      Possibly-null CustomEntity instance.

    • convert

      @Nullable public static @Nullable CustomEntity convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, boolean frustumCulling)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      bukkitEntity - the Bukkit entity you want to convert.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      Returns:
      Possibly-null CustomEntity instance.

    • convert

      @Nullable public static @Nullable CustomEntity convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, boolean frustumCulling, boolean noHitbox, boolean canBaseEntityBeDestroyed, boolean hideBaseEntity)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      bukkitEntity - the Bukkit entity you want to convert.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      noHitbox - specify if this custom entity bones have the armorstands hitboxes or not.
      canBaseEntityBeDestroyed - if the base Bukkit entity can be destroyed if the custom entities dies/is removed.
      hideBaseEntity - if the base Bukkit entity must be hidden on the client or not.
      Returns:
      Possibly-null CustomEntity instance.

    • convert

      @Nullable public static @Nullable CustomEntity convert(String namespacedId, org.bukkit.entity.LivingEntity bukkitEntity, List<org.bukkit.entity.Player> viewers, boolean frustumCulling)
      Spawns a CustomEntity and returns the created CustomEntity instance, or null if Namespace and ID are invalid.
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id to get the CustomEntity from.
      bukkitEntity - the Bukkit entity you want to convert.
      viewers - the list of players which can see this entity.
      frustumCulling - if this entity needs to be frozen if not visible by the player.
      Returns:
      Possibly-null CustomEntity instance.

    • byAlreadySpawned

      @Nullable public static @Nullable CustomEntity byAlreadySpawned(org.bukkit.entity.Entity entity)
      Gets a CustomEntity instance through a Bukkit Entity.
      This returns null if the provided Entity doesn't belong to a CustomEntity.
      Parameters:
      entity - The Bukkit Entity to get the CustomEntity from.
      Returns:
      Possibly-null CustomEntity instance.

    • isCustomEntity

      public static boolean isCustomEntity(org.bukkit.entity.Entity entity)

    • isCustomEntity

      public static boolean isCustomEntity(UUID uuid)

    • getEntity

      public org.bukkit.entity.Entity getEntity()
      Gets the Bukkit Entity associated with this CustomEntity.
      Returns:
      The Bukkit Entity associated with the CustomEntity.

    • getType

      public org.bukkit.entity.EntityType getType()
      Gets the Bukkit EntityType associated with this CustomEntity.
      Returns:
      The Bukkit EntityType associated with the CustomEntity.

    • getLocation

      public org.bukkit.Location getLocation()

    • teleport

      public void teleport(org.bukkit.Location location)

    • getNamespacedID

      public String getNamespacedID()
      Gets the Namespace and ID in the format namespace:id for this CustomEntity.
      Returns:
      String representing the namespace and ID of the CustomEntity.

    • getNamespace

      public String getNamespace()
      Gets the Namespace for this CustomEntity.
      Returns:
      String representing the namespace of the CustomEntity.

    • getId

      public String getId()
      Gets the ID of this CustomEntity.
      Returns:
      String representing the ID of the CustomEntity.

    • respawn

      public void respawn(org.bukkit.entity.Player player)
      Sends respawn packets to the specified player
      Parameters:
      player - the player to send packets to

    • addViewer

      public void addViewer(org.bukkit.entity.Player player)

    • removeViewer

      public void removeViewer(org.bukkit.entity.Player player)

    • setFrustumCulling

      public void setFrustumCulling(boolean cull)

    • getFrustumCulling

      public boolean getFrustumCulling()

    • playAnimation

      public boolean playAnimation(String name, @Nullable @Nullable Runnable callback)
      Plays an animation and executes an action after it's finished
      Parameters:
      name - the animation name
      callback - the action to be executed after the animation is finished
      Returns:
      true if the animation was played, otherwise false

    • playAnimation

      public boolean playAnimation(String name)
      Plays an animation
      Parameters:
      name - the animation name
      Returns:
      true if the animation was played, otherwise false

    • stopAnimation

      public void stopAnimation()
      Stops the currently playing animation

    • isPlayingAnimation

      public boolean isPlayingAnimation(String name)

    • hasAnimation

      public static boolean hasAnimation(String entityNamespacedId, String animationName)
      Check if a custom entity model has an animation registered by its name
      Parameters:
      entityNamespacedId - the custom entity identifier in the format namespace:id
      animationName - the animation name
      Returns:
      true if the animation exists, otherwise false

    • hasAnimation

      public boolean hasAnimation(String name)
      Check if this custom entity model has an animation registered
      Parameters:
      name - the animation name
      Returns:
      true if the animation exists, otherwise false

    • getAnimationsNames

      public static List<String> getAnimationsNames(String entityNamespacedId)
      Get all custom entity model animations registered by its name
      Parameters:
      entityNamespacedId - the custom entity identifier in the format namespace:id
      Returns:
      a list of the animations registered for a custom entity

    • getAnimationsNames

      public List<String> getAnimationsNames()
      Get all custom entity model animations for this custom entity
      Returns:
      a list of the animations registered for a custom entity

    • destroy

      public void destroy()
      Completely removes this entity from the world

    • playDamageEffect

      public void playDamageEffect(boolean fire)
      Plays red color animation and sets entity on fire if needed
      Parameters:
      fire - if the fire animation must be played or not

    • setColorAllBones

      public void setColorAllBones(int color)
      Changes color of every bone of this custom entity.
      Parameters:
      color - the color, can be obtained with tools like this: https://minecraftcommand.science/armor-color

    • setEnchantedAllBones

      public void setEnchantedAllBones(boolean enchanted)
      Set enchant effect to every bone of this custom entity.
      Parameters:
      enchanted - true if enchanted, otherwise false.

    • hasMountBones

      public boolean hasMountBones()
      Check if this entity has any mount bone and can be mounted by players
      Returns:
      true if it can be mounted, otherwise false

    • addPassenger

      public boolean addPassenger(org.bukkit.entity.LivingEntity passenger)
      Adds a passenger to this entity to the first available mount slot
      Parameters:
      passenger - the player to mount
      Returns:
      true if successful, otherwise false

    • removePassenger

      public static void removePassenger(org.bukkit.entity.LivingEntity passenger)
      Ejects this player only if it's on a custom entity.
      Parameters:
      passenger - the player to eject

    • getPassengers

      public Set<org.bukkit.entity.LivingEntity> getPassengers()

    • hasPassenger

      public boolean hasPassenger(org.bukkit.entity.LivingEntity passenger)
      Parameters:
      passenger - passenger Entity to check
      Returns:
      true if this passenger rides the customEntity, otherwise false

    • hasPassenger

      public boolean hasPassenger()
      Returns:
      true if there is at least one passenger, otherwise false

    • setPassenger

      public boolean setPassenger(org.bukkit.entity.LivingEntity passenger, int ordinal) throws IllegalArgumentException, IndexOutOfBoundsException
      Sets the passenger of the specified CustomEntity.MountBone
      Parameters:
      passenger - passenger to set
      ordinal - index of the CustomEntity.MountBone
      Returns:
      true if the passenger was successfully set
      Throws:
      IllegalArgumentException - if there is no CustomEntity.MountBone with such index
      IndexOutOfBoundsException

    • getBones

      public Set<CustomEntity.Bone> getBones()
      Returns:
      all bones of the current CustomEntity

    • getMountBones

      public Set<CustomEntity.MountBone> getMountBones()
      Returns:
      all mount bones of the current CustomEntity

    • getBone

      public CustomEntity.Bone getBone(int index) throws IndexOutOfBoundsException
      Parameters:
      index - bone index within the CustomEntity
      Returns:
      CustomEntity.Bone at the specified index
      Throws:
      IndexOutOfBoundsException - if there is no bone with such index

    • getBone

      @Nullable public @Nullable CustomEntity.Bone getBone(String name)
      Parameters:
      name - bone name
      Returns:
      CustomEntity.Bone at the specified name. Returns null if not found.

    • getMountBoneByPassenger

      @Nullable public @Nullable CustomEntity.MountBone getMountBoneByPassenger(org.bukkit.entity.LivingEntity passenger)
      Gets the CustomEntity.MountBone currently ridden by the specified passenger if so
      Parameters:
      passenger - passenger to check
      Returns:
      Optional of the CustomEntity.MountBone. Not empty if there is such passenger

    • getLoot

      public List<org.bukkit.inventory.ItemStack> getLoot()

    • getLoot

      public List<org.bukkit.inventory.ItemStack> getLoot(@Nullable @Nullable org.bukkit.inventory.ItemStack tool)

    • getLoot

      public static List<org.bukkit.inventory.ItemStack> getLoot(org.bukkit.entity.LivingEntity bukkitEntity, @Nullable @Nullable org.bukkit.inventory.ItemStack tool)