Package-level declarations

Types

Link copied to clipboard
class AnimatedDye(ticksPerColor: Provider<Int>, colors: Provider<List<Color>>) : ItemBehavior

Animates the minecraft:dyed_color component by interpolating between a given set of colors.

Link copied to clipboard

Allows items to store energy and be charged.

Link copied to clipboard
class Consumable(nutrition: Provider<Int>, saturation: Provider<Float>, canAlwaysEat: Provider<Boolean>, consumeTime: Provider<Int>, remains: Provider<ItemStack?>, possibleEffects: Provider<Map<PotionEffect, Float>>, animation: Provider<ItemUseAnimation>, sound: Provider<Holder<SoundEvent>>, particles: Provider<Boolean>) : ItemBehavior

Allows items to be consumed.

Link copied to clipboard
class Cooldown(val cooldown: Provider<Int>, val group: Provider<Key>) : ItemBehavior

Adds a use cooldown to items.

Link copied to clipboard
class Damageable(maxDurability: Provider<Int>, itemDamageOnAttackEntity: Provider<Int>, itemDamageOnBreakBlock: Provider<Int>, repairIngredient: Provider<RecipeChoice?>) : ItemBehavior

Allows items to store and receive damage.

Link copied to clipboard

Makes items dyeable.

Link copied to clipboard
class Enchantable(enchantmentValue: Provider<Int>, primaryEnchantments: Provider<Set<Enchantment>>, supportedEnchantments: Provider<Set<Enchantment>>) : ItemBehavior

Makes an item enchantable.

Link copied to clipboard
class Equippable(equipment: Provider<Equipment?>, slot: Provider<EquipmentSlot>, armor: Provider<Double>, armorToughness: Provider<Double>, knockbackResistance: Provider<Double>, equipSound: Provider<Holder<SoundEvent>>, allowedEntities: Provider<Set<EntityType>?>, dispensable: Provider<Boolean>, swappable: Provider<Boolean>, damageOnHurt: Provider<Boolean>) : ItemBehavior

Allows items to be worn in armor slots.

Link copied to clipboard

Allows items to extinguish campfires.

Link copied to clipboard

Makes items fire-resistant.

Link copied to clipboard

Allows items to flatten the ground.

Link copied to clipboard
class Fuel(burnTime: Provider<Int>) : ItemBehavior

Allows items to be used as fuel in furnaces.

Link copied to clipboard

Allows elytra-like gliding if equipped.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed interface ItemBehaviorHolder
Link copied to clipboard

Interface for item behaviors that contain an ItemFilter of type T.

Link copied to clipboard

Allows items to strip blocks.

Link copied to clipboard

Allows items to till the ground.

Link copied to clipboard
class Tool(tier: Provider<ToolTier>, categories: Provider<Set<ToolCategory>>, breakSpeed: Provider<Double>, attackDamage: Provider<Double?>, attackSpeed: Provider<Double?>, knockbackBonus: Provider<Int>, canSweepAttack: Provider<Boolean>, canBreakBlocksInCreative: Provider<Boolean>) : ItemBehavior

Allows items to be used as tools, by specifying break and attack properties.

Functions

Link copied to clipboard
fun AnimatedDye(defaultTicksPerColor: Int? = null, defaultColors: List<Color>? = null): ItemBehaviorFactory<AnimatedDye>

Creates a factory for AnimatedDye behaviors using the given values, if not specified otherwise in the config.

Link copied to clipboard
fun Chargeable(maxEnergy: Long? = null, affectsItemDurability: Boolean = true): ItemBehaviorFactory<Chargeable>

Creates a factory for Chargeable behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Consumable(nutrition: Int = 0, saturation: Float = 0.0f, canAlwaysEat: Boolean = false, consumeTime: Int = 32, remains: ItemStack? = null, possibleEffects: Map<PotionEffect, Float>? = null, animation: ItemUseAnimation = ItemUseAnimation.EAT, sound: Holder<SoundEvent> = SoundEvents.GENERIC_EAT, particles: Boolean = true): ItemBehaviorFactory<Consumable>

Creates a factory for Consumable behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Cooldown(cooldown: Int? = null, group: Key? = null): ItemBehaviorFactory<Cooldown>

Creates a factory for Cooldown behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Damageable(maxDurability: Int? = null, itemDamageOnAttackEntity: Int = 0, itemDamageOnBreakBlock: Int = 0, repairIngredient: RecipeChoice? = null): ItemBehaviorFactory<Damageable>

Creates a factory for Damageable behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Enchantable(enchantmentValue: Int? = null, primaryEnchantments: Provider<Set<Enchantment>>? = null, supportedEnchantments: Provider<Set<Enchantment>>? = null): ItemBehaviorFactory<Enchantable>

Creates a factory for Enchantable behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Equippable(equipment: Equipment, slot: EquipmentSlot, armor: Double = 0.0, armorToughness: Double = 0.0, knockbackResistance: Double = 0.0, equipSound: Key, allowedEntities: Set<EntityType>? = null, dispensable: Boolean = true, swappable: Boolean = true, damageOnHurt: Boolean = true): ItemBehaviorFactory<Equippable>
fun Equippable(equipment: Equipment?, slot: EquipmentSlot, armor: Double = 0.0, armorToughness: Double = 0.0, knockbackResistance: Double = 0.0, equipSound: Holder<SoundEvent> = SoundEvents.ARMOR_EQUIP_GENERIC, allowedEntities: Set<EntityType>? = null, dispensable: Boolean = true, swappable: Boolean = true, damageOnHurt: Boolean = true): ItemBehaviorFactory<Equippable>

Creates a factory for Equippable behaviors using the given values, if not specified in the item's configuration.

Link copied to clipboard
fun Fuel(burnTime: Int? = null): ItemBehaviorFactory<Fuel>

Creates a factory for Fuel behaviors using the given values, if not specified otherwise in the item's config.

Link copied to clipboard
fun Tool(tier: ToolTier? = null, categories: Set<ToolCategory>? = null, breakSpeed: Double? = null, attackDamage: Double? = null, attackSpeed: Double? = null, knockbackBonus: Int = 0, canSweepAttack: Boolean = false, canBreakBlocksInCreative: Boolean = true): ItemBehaviorFactory<Tool>

Creates a factory for Tool behaviors using the given values, if not specified otherwise in the config.