Package dev.lone.itemsadder.api

Class CustomFurniture

java.lang.Object
dev.lone.itemsadder.api.CustomStack
dev.lone.itemsadder.api.CustomFurniture
public class CustomFurniture extends CustomStack
Class representing a CustomFurniture of ItemsAdder.
This class extends the CustomStack class.

  • Constructor Details

    • CustomFurniture

      public CustomFurniture()

  • Method Details

    • getNamespacedIdsInRegistry

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

    • byAlreadySpawned

      @Nullable public static @Nullable CustomFurniture byAlreadySpawned(org.bukkit.entity.Entity entity)
      Gets a CustomFurniture instance from the provided Armor stand.
      This may return null if the Armor stand is not part of a furniture.
      Parameters:
      entity - The Entity to get the CustomFurniture from.
      Returns:
      Possibly-null instance of CustomFurniture

    • byAlreadySpawned

      @Nullable public static @Nullable CustomFurniture byAlreadySpawned(org.bukkit.block.Block block)
      Gets a CustomFurniture instance from the provided Block.
      This may return null if the Block is not part of a furniture hit-box.
      Parameters:
      block - The Block to get the CustomFurniture from.
      Returns:
      Possibly-null instance of CustomFurniture

    • spawnPreciseNonSolid

      @Nullable public static @Nullable CustomFurniture spawnPreciseNonSolid(String namespacedId, org.bukkit.Location location)
      Spawns an Armor stand with the furniture of the provided namespace and ID at the provided location and returns a CustomFurniture instance for it.

      No Barrier block will be spawned if the CustomFurniture is solid!

      Parameters:
      namespacedId - Namespace and ID of the CustomFurniture in the format namespace:id
      location - The Location to spawn the Armor stand with the furniture at.
      Returns:
      Possibly-null CustomFurniture instance.

    • spawn

      @Nullable public static @Nullable CustomFurniture spawn(String namespacedId, org.bukkit.block.Block blockLocation)
      Spawns an Armor stand with the furniture of the provided namespace and ID at the provided Block location and returns a CustomFurniture instance for it.
      This may return null if the provided namespace and ID are invalid.

      No Barrier block will be spawned if the CustomFurniture is solid!

      Parameters:
      namespacedId - Namespace and ID of the CustomFurniture in the format namespace:id
      blockLocation - The Block to spawn the Armor stand with the furniture at.
      Returns:
      Possibly-null CustomFurniture instance.

    • remove

      public void remove(boolean dropItem)
      Removes this CustomFurniture and the Armor stand associated with it from the world.
      Parameters:
      dropItem - if an item should be dropped.

    • remove

      public static void remove(org.bukkit.entity.Entity entity, boolean dropItem)
      Removes this CustomFurniture and the Armor stand associated with it from the world.
      Parameters:
      entity - the Entity to remove with the CustomFurniture.
      dropItem - if an item should be dropped.

    • teleport

      public void teleport(org.bukkit.entity.Entity destinationEntity)
      Teleports the Armor stand associated with this CustomFurniture to the target Bukkit Entity.
      This will also remove any Barrier blocks from its original position, if present.
      Parameters:
      destinationEntity - the Bukkit Entity to teleport towards.

    • teleport

      public void teleport(org.bukkit.Location location)
      Teleports the Armor stand associated with this CustomFurniture to the provided location.
      This will also remove any Barrier blocks from its original position, if present.
      Parameters:
      location - the location to teleport towards.

    • replaceFurniture

      public void replaceFurniture(String newFurnitureNamespacedId)
      Replace the model of this furniture with the model of another furniture.
      Parameters:
      newFurnitureNamespacedId - the namespace and ID of the new furniture model.

    • replaceFurniture

      public void replaceFurniture(String newFurnitureNamespacedId, org.bukkit.Color color)
      Replace the model of this furniture with the model of another furniture.
      Parameters:
      newFurnitureNamespacedId - the namespace and ID of the new furniture model.
      color - the new color of this furniture. Will apply only to naturally colorable items.

    • setColor

      public void setColor(org.bukkit.Color color)
      Replace color of this furniture. Will apply only to naturally colorable items.
      Parameters:
      color - the new color of this furniture. Will apply only to naturally colorable items.

    • getOriginalLightLevel

      public int getOriginalLightLevel()
      Returns the original light level of this CustomFurniture.
      Returns:
      Integer representing the original light level of the CustomFurniture.

    • setCurrentLightLevel

      public void setCurrentLightLevel(int level)
      Sets the current light level for this CustomFurniture.
      Parameters:
      level - The light level to set for this CustomFurniture.

    • getArmorstand

      @Nullable public @Nullable org.bukkit.entity.Entity getArmorstand()
      Deprecated.
      use getEntity() instead.
      Gets the Armor stand associated with this CustomFurniture.
      This may return null if the Armor stand is not yet spawned in the world.
      Returns:
      Possibly-null Bukkit Entity instance.

    • getEntity

      @Nullable public @Nullable org.bukkit.entity.Entity getEntity()
      Gets the Armor stand associated with this CustomFurniture.
      This may return null if the Armor stand is not yet spawned in the world.
      Returns:
      Possibly-null Bukkit Entity instance.