VentureLibs/net.blockventuremc.utils.itembuilder/ItemBuilder

ItemBuilder

class ItemBuilder(material: Material, count: Int = 1, dsl: ItemBuilder.() -> Unit = {})(source)

The ItemBuilder class is used for building ItemStack objects with various properties and customizations. It provides methods for modifying the display name, lore, enchantments, flags, and other attributes of an ItemStack.

Parameters

material

The material of the ItemStack.

count

The count (stack size) of the ItemStack. Default is 1.

dsl

The DSL (Domain Specific Language) block that can be used to customize the item. Default is an empty block.

Constructors

constructor(material: Material, count: Int = 1, dsl: ItemBuilder.() -> Unit = {})

Types

object Companion

This class represents a companion object for the ItemBuilder class. It provides utility methods for creating ItemBuilder instances from ItemStack objects.

@FunctionalInterface

fun interface Performer<T>

Functional interface representing a performer that performs an operation on an item.

Properties

var itemStack: ItemStack

The itemStack to get. This variable represents an ItemStack object that can be created using the material and count parameters.

Functions

addPersistentData

fun addPersistentData(key: NamespacedKey, value: String): ItemBuilder

Adds persistent data to the item.

fun <T : Any> addPersistentData(key: NamespacedKey, persistentDataType: PersistentDataType<T, T>, value: T): ItemBuilder

Adds persistent data to the item stack.

addPersistentDataIf

fun addPersistentDataIf(key: NamespacedKey, value: String, condition: Boolean = false): ItemBuilder

Adds persistent data to the item if the specified condition is true.

fun build(): ItemStack

Retrieves the built ItemStack from the builder.

fun clearDisplay(): ItemBuilder

Clears the display name of the item.

fun clearDisplayIf(condition: Boolean = false): ItemBuilder

Clears the display of the item if the given condition is true.

fun clearEnchants(): ItemBuilder

Clear all enchantments on the item.

clearEnchantsIf

fun clearEnchantsIf(condition: Boolean = false): ItemBuilder

Clears all enchantments if the specified condition is true.

fun clearFlags(): ItemBuilder

Clears all flags of the item.

fun clearFlagsIf(condition: Boolean = false): ItemBuilder

Clears the flags of the ItemBuilder object if the provided condition is true.

fun clearLore(): ItemBuilder

Clears the lore of the item.

fun clearLoreIf(condition: Boolean = false): ItemBuilder

Clears the lore of the ItemBuilder if the given condition is true.

fun clone(): ItemBuilder

Creates a deep copy of the current ItemBuilder object.

fun condition(condition: Boolean, consumer: ItemBuilder.Performer<ItemBuilder>): ItemBuilder

Checks the given condition and performs the specified operation on the ItemBuilder if the condition is true.

customModelData

fun customModelData(modelData: Int): ItemBuilder

Sets the custom model data for an item.

fun display(displayName: String): ItemBuilder

Change the displayname of the item.

fun displayIf(displayName: String, condition: Boolean = false): ItemBuilder

Change the displayname of the item if a certain condition is true.

fun enchant(enchants: Map<Enchantment, Int>): ItemBuilder

Adds enchants to the item.

fun enchantIf(enchants: Map<Enchantment, Int>, condition: Boolean = false): ItemBuilder

Add enchants if condition is true

fun flag(vararg flags: ItemFlag): ItemBuilder

Add flags to the item.

fun lore(vararg lores: String): ItemBuilder

Adds lore to an ItemBuilder object.

fun loreIf(vararg lores: String, condition: Boolean = false): ItemBuilder

Adds lore to the item builder if the given condition is true.

fun <T : ItemMeta> meta(dsl: T.() -> Unit): ItemBuilder

Updates the item meta by applying the provided DSL (Domain Specific Language) to it.

fun onClick(onClick: (InventoryClickEvent) -> Unit): ItemBuilder

Sets the click event for the item.

fun owner(uuid: UUID): ItemBuilder

Sets the owning player of the skull item.

fun owner(name: String): ItemBuilder

Sets the owner of the skull to the given name.

fun owner(offlinePlayer: OfflinePlayer): ItemBuilder

Sets the owner of the Player Head item.

removePersistantDataIf

fun removePersistantDataIf(key: NamespacedKey, condition: Boolean = false): ItemBuilder

Removes persistent data from the item if the condition is true.

@ApiStatus.Internal

fun setConsumable(consumable: Boolean): ItemBuilder

Sets the consumable state of the item. This method is not yet supported in PaperMC 1.21.1.

@ApiStatus.Internal

fun setEquippable(slot: EquipmentSlot, equippable: Boolean): ItemBuilder

Sets the equippable state of the item in the specified slot. This method is not yet supported in PaperMC 1.21.1.

fun setGlinting(glinting: Boolean): ItemBuilder

fun setGlinting(glinting: Boolean, force: Boolean = false): ItemBuilder

Sets whether the item should have a glint effect or not.

fun setOwner(uuid: UUID): ItemBuilder

Sets the owner of the player skull.

fun texture(texture: String): ItemBuilder

Sets the texture of the item to the specified texture.

textureFromMineSkin

fun textureFromMineSkin(mineSkinUUID: String): ItemBuilder

Retrieves the skin texture of a player from MineSkin API based on the provided MineSkin UUID.

fun type(material: Material): ItemBuilder

Sets the material of the item stack.

fun typeIf(material: Material, condition: Boolean = false): ItemBuilder

Sets the type of the material in the ItemBuilder, if the given condition is true.