Class ItemRegistration.ItemDefinitionBuilder

java.lang.Object

ke.ric.api.registration.ItemRegistration.ItemDefinitionBuilder

Enclosing class:

ItemRegistration

public static class ItemRegistration.ItemDefinitionBuilder
extends Object

Builder for creating custom item definitions.

Method Summary

Modifier and Type	Method	Description
ItemRegistration.ItemDefinitionBuilder	addEffect(org.bukkit.potion.PotionEffectType effectType, int durationTicks, int amplifier)	Add a guaranteed potion effect (100% chance).
ItemRegistration.ItemDefinitionBuilder	addEffect(org.bukkit.potion.PotionEffectType effectType, int durationTicks, int amplifier, float probability)	Add a potion effect when this item is consumed.
ItemRegistration.ItemDefinitionBuilder	addonId(String addonId)	Mark this item as owned by an addon.
ItemRegistration.ItemDefinitionBuilder	animation(String animation)
ItemRegistration.ItemDefinitionBuilder	baseMaterial(org.bukkit.Material material)
CustomItemManager.CustomItemDefinition	build()	Build the item definition.
ItemRegistration.ItemDefinitionBuilder	canAlwaysEat(boolean canAlwaysEat)
ItemRegistration.ItemDefinitionBuilder	color(org.bukkit.Color color)
ItemRegistration.ItemDefinitionBuilder	consumeSeconds(float seconds)
ItemRegistration.ItemDefinitionBuilder	edible(boolean edible)
ItemRegistration.ItemDefinitionBuilder	feast(boolean feast)
ItemRegistration.ItemDefinitionBuilder	foodValue(int foodValue)
ItemRegistration.ItemDefinitionBuilder	id(String id)
ItemRegistration.ItemDefinitionBuilder	name(String name)
ItemRegistration.ItemDefinitionBuilder	particleBlock(org.bukkit.Material particleBlock)	Set the block material used for eating particles.
ItemRegistration.ItemDefinitionBuilder	placeable(boolean placeable)	Allow this item to be placed as a block (generic).
ItemRegistration.ItemDefinitionBuilder	placeableServings(int servings)	Make this food placeable as a block and consumable in servings (cake-like).
ItemRegistration.ItemDefinitionBuilder	saturation(float saturation)
ItemRegistration.ItemDefinitionBuilder	tags(String... tags)	Add reusable normalized ingredient tags to this custom item.
ItemRegistration.ItemDefinitionBuilder	texture(String textureUrl)
ItemRegistration.ItemDefinitionBuilder	visualId(String visualId)	Set the logical visual ID for this item.

Methods inherited from class Object

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

Method Details

id

public ItemRegistration.ItemDefinitionBuilder id(String id)

name

public ItemRegistration.ItemDefinitionBuilder name(String name)

baseMaterial

public ItemRegistration.ItemDefinitionBuilder baseMaterial(org.bukkit.Material material)

texture

public ItemRegistration.ItemDefinitionBuilder texture(String textureUrl)

edible

public ItemRegistration.ItemDefinitionBuilder edible(boolean edible)

foodValue

public ItemRegistration.ItemDefinitionBuilder foodValue(int foodValue)

saturation

public ItemRegistration.ItemDefinitionBuilder saturation(float saturation)

consumeSeconds

public ItemRegistration.ItemDefinitionBuilder consumeSeconds(float seconds)

canAlwaysEat

public ItemRegistration.ItemDefinitionBuilder canAlwaysEat(boolean canAlwaysEat)

animation

public ItemRegistration.ItemDefinitionBuilder animation(String animation)

addEffect

public ItemRegistration.ItemDefinitionBuilder addEffect(org.bukkit.potion.PotionEffectType effectType,
 int durationTicks,
 int amplifier,
 float probability)

Add a potion effect when this item is consumed.

Parameters:

effectType - The potion effect type

durationTicks - Duration in ticks (20 ticks = 1 second)

amplifier - Effect amplifier (0 = level I, 1 = level II, etc.)

probability - Chance to apply (0.0-1.0)

addEffect

public ItemRegistration.ItemDefinitionBuilder addEffect(org.bukkit.potion.PotionEffectType effectType,
 int durationTicks,
 int amplifier)

Add a guaranteed potion effect (100% chance).

particleBlock

public ItemRegistration.ItemDefinitionBuilder particleBlock(org.bukkit.Material particleBlock)

Set the block material used for eating particles. If not set, falls back to default particle colors.

placeableServings

public ItemRegistration.ItemDefinitionBuilder placeableServings(int servings)

Make this food placeable as a block and consumable in servings (cake-like). Only PLAYER_HEAD-based foods are supported for placeable servings.

Parameters:

servings - Number of servings (0 to disable)

placeable

public ItemRegistration.ItemDefinitionBuilder placeable(boolean placeable)

Allow this item to be placed as a block (generic).

feast

public ItemRegistration.ItemDefinitionBuilder feast(boolean feast)

color

public ItemRegistration.ItemDefinitionBuilder color(org.bukkit.Color color)

visualId

public ItemRegistration.ItemDefinitionBuilder visualId(String visualId)

Set the logical visual ID for this item. Visual providers resolve it using their own conventions.

addonId

public ItemRegistration.ItemDefinitionBuilder addonId(String addonId)

Mark this item as owned by an addon. The item remains unavailable when the addon is not registered.

tags

public ItemRegistration.ItemDefinitionBuilder tags(String... tags)

Add reusable normalized ingredient tags to this custom item.

build

public CustomItemManager.CustomItemDefinition build()

Build the item definition.