peanut-framework / Classes/Features/item / Item
Class: Item
Item class used for creating custom items.
Param
The string that is used in-game to identify the item.
Param
Optional (but recommended), the string to show up as the display name of the item in-game.
Param
Optional, the language the display name originates from. Defaults to en_US.
Example
new Item("peanut:example", "Example Item")Constructors
new Item()
new Item(
identifier,
displayName?,
language?): ItemParameters
identifier
string
displayName?
string
language?
Returns
Methods
allowOffHand()
allowOffHand(value): ItemDetermine whether an item can be placed in the off-hand slot of the inventory.
Parameters
value
boolean
Boolean value.
Returns
blockPlacer()
blockPlacer(block, useOn?): ItemBlock Placer item component. Items with this component will place a block when used.
Parameters
block
string
The block that will be placed.
useOn?
List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed.
Example
new Item("peanut:rose_flower_basket", "Basket of Roses")
.blockPlacer("minecraft:poppy", ["minecraft:grass_block", "minecraft:dirt"])Returns
bundleInteraction()
bundleInteraction(numViewableSlots): ItemEnables the bundle interface and functionality on the item.
Parameters
numViewableSlots
number
Defines the maximum number of item stacks accessible from the top of the bundle. Slots are accessed in rows filling from the bottom of the tooltip from right to left.
Returns
canDestroyInCreative()
canDestroyInCreative(value): ItemDetermines if the item will break blocks in Creative Mode while swinging.
Parameters
value
boolean
Boolean value.
Returns
compile()
compile(project): voidCompiles a finished item class to JSON. This process is automatic.
Parameters
project
Returns
void
cooldown()
cooldown(category, duration): ItemThe type of cool down for this item.
Parameters
category
string = "attack"
The type of cool down for this item.
duration
number
The duration of time (in seconds) items with a matching category will spend cooling down before becoming usable again. If this value is a negative number, it renders the item unusable.
Returns
customComponent()
customComponent(component): ItemCustom components are a new way of connecting the configuration of Blocks and Items in JSON to the power of scripting in a very direct and targeted manner.
Parameters
component
string[]
String array of custom component IDs.
Returns
damage()
damage(value): ItemDetermines how much extra damage the item does on attack.
Parameters
value
number
How much extra damage the item does on attack. Note that this must be a positive value.
Returns
damageAbsorption()
damageAbsorption(absorbableCauses): ItemCauses the item to absorb damage that would otherwise be dealt to its wearer.
Parameters
absorbableCauses
string[]
List of damage causes (such as entity_attack and magma) that can be absorbed by the item.
Returns
digger()
digger(useEfficiency, destroySpeeds): ItemDetermine how quickly an item can dig specific blocks.
Parameters
useEfficiency
boolean
Determines whether the item should be impacted if the efficiency enchant is applied to it. Does not seem to work.
destroySpeeds
object[]
A list of blocks to dig, with correlating speeds of digging.
Returns
durability()
durability(maxDurability, damageChance?): ItemDetermines how much damage the item can take before breaking, and allows the item to be combined in crafting.
Parameters
maxDurability
number
Max durability is the amount of damage that this item can take before breaking. This is a required parameter with a minimum value of 0.
damageChance?
Damage chance is the percentage chance of this item losing durability. Default is set at 100. Defined as an int range with min and max value.
max
number
min
number
Returns
durabilitySensor()
durabilitySensor(durabilityThresholds): ItemEnables an item to emit effects when it receives damage.
Parameters
durabilityThresholds
object[]
Items define both the durability thresholds, and the effects emitted when each threshold is met.
Returns
dyeable()
dyeable(defaultColor?): ItemAllows the item to be dyed by cauldron water.
Parameters
defaultColor?
string
Optional hex color to use by default before the player has dyed the item.
Returns
enchantable()
enchantable(slot, value): ItemDetermines what enchantments can be applied to the item.
Parameters
slot
What enchantments can be applied (ex. Using bow would allow this item to be enchanted as if it were a bow).
value
number
The value of the enchantment (minimum of 0).
Returns
entityPlacer()
entityPlacer(
entity,
dispenseOn?,
useOn?): ItemAllows the item to place specified entities into the world.
Parameters
entity
string
The entity to be placed in the world.
dispenseOn?
string[]
List of block descriptors that contain blocks that this item can be dispensed on. If left empty, all blocks will be allowed.
useOn?
string[]
List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed.
Returns
food()
food(
foodOptions,
canAlwaysEat,
usingConvertsTo?): ItemWhen an item has a food component, it becomes edible to the player.
Parameters
foodOptions
nutrition
number
saturationModifier
number
canAlwaysEat
boolean = false
If true you can always eat this item (even when not hungry).
usingConvertsTo?
string
When used, converts to the item specified by the string in this field.
Returns
fuel()
fuel(duration): ItemAllows the item to be used as fuel in a furnace to 'cook' other items.
Parameters
duration
number
How long in seconds will this fuel cook items for. Minimum value: 0.05.
Returns
glint()
glint(value): ItemDetermines whether the item has the enchanted glint render effect on it.
Parameters
value
boolean
Boolean value.
Returns
handEquipped()
handEquipped(value): ItemDetermines if an item is rendered like a tool while in-hand.
Parameters
value
boolean
Boolean value.
Returns
hoverTextColor()
hoverTextColor(color): ItemDetermines the color of the item name when hovering over it.
Parameters
color
string
Valid colors can be found here: https://minecraft.wiki/w/Formatting_codes#Color_codes
Returns
icon()
icon(
name,
path,
options?): ItemDetermines the icon to represent the item in the Ul and elsewhere.
Parameters
name
string
path
string
options?
dyed
string
icon_trim
string
Returns
interactButton()
interactButton(value): ItemThis component is a boolean or string that determines if the interact button is shown in touch controls and what text is displayed on the button.
Parameters
value
When set to true, default "Use Item" text will be used.
string | boolean
Returns
liquidClipped()
liquidClipped(value): ItemDetermines whether an item interacts with liquid blocks on use.
Parameters
value
boolean
Boolean value.
Returns
maxStackSize()
maxStackSize(value): ItemThe maximum number of items that can be held in one stack of this item type.
Parameters
value
number
Integer value.
Returns
menuCategory()
menuCategory(category): ItemAssigns this item to a menu category and/or creative item group.
Parameters
category
Category to assign.
Returns
projectile()
projectile(projectileEntity, minimumCriticalPower): ItemProjectile item component. Projectile items shoot out, like an arrow.
Parameters
projectileEntity
string
The entity to be fired as a projectile. If no namespace is specified, it is assumed to be minecraft.
minimumCriticalPower
number = 1
Defines the time a projectile needs to charge in order to critically hit.
Returns
rarity()
rarity(rarity): ItemRepresents how difficult the item is to obtain by changing the color of its name text.
Parameters
rarity
Rarity of the item.
"common" | "uncommon" | "rare" | "epic"
Returns
record()
record(
comparatorSignal,
duration,
soundEvent): ItemThe record item component allows the item to play a sound when used in a jukebox.
Parameters
comparatorSignal
number
Signal strength for comparator blocks to use. While this value can be any number(even negative!), the comparator signal still locks itself between {0, 15}.
duration
number
Duration of sound event in seconds float value.
soundEvent
string
Sound event types. If sound type is any of the vanilla music discs, the item will have the lore of the artist's name. When played in a jukebox, an actionbar will appear on the player's screen describing what record is being played. Regardless of what sound type used, the item's text color will change to aqua just like vanilla music discs. Only vanilla sound events are allowed.
Returns
repairable()
repairable(repairItems): ItemDetermines whether an item can be repaired in an anvil
Parameters
repairItems
object[]
List of repair item entries.
Returns
shooter()
shooter(
ammunition,
chargeOnDraw,
maxDrawDuration,
scalePowerByDrawDuration): ItemShooter Item Component. Must have the minecraft:use_modifiers component in order to function properly.
Parameters
ammunition
object[]
chargeOnDraw
boolean
Sets if the item is charged when drawn. Item's minecraft:use_modifiers -> use_duration must be >= max_draw_duration.
maxDrawDuration
number
Determines how long can the weapon can be drawn before releasing automatically.
scalePowerByDrawDuration
boolean
When set to true, the longer the weapon is drawn, the more power it will have when released.
Returns
shouldDespawn()
shouldDespawn(value): ItemAllows you to specify whether the item should despawn when dropped on the ground.
Parameters
value
boolean
Boolean value.
Returns
stackedByData()
stackedByData(value): ItemAllows you to specify whether the item should stack by data or not.
Parameters
value
boolean
Boolean value.
Returns
storageItem()
storageItem(
max_slots,
max_weight_limit,
weight_in_storage_item,
allow_nested_storage_items,
banned_items): ItemStorage item component. Items with this component will open a Storage Ul when used.
Parameters
max_slots
number = 64
max_weight_limit
number = 64
weight_in_storage_item
number = 1
allow_nested_storage_items
boolean = false
banned_items
string[] = ...
Returns
tag()
tag(tags): ItemTags are empty JSON Objects that define a tag to be added to an item. The component has no body or parameters, it is simply a flag, and when the item is parsed it will be added to the item's tag list.
Parameters
tags
A list of tags to be added to the item.
string[] | VanillaItemTag[]
Returns
throwable()
throwable(
doSwingAnimation,
launchPowerScale,
maxDrawDuration,
maxLaunchPower,
minDrawDuration,
scalePowerByDrawDuration): ItemThrowable items, such as a snowball. Item must have the .projectile() component.
Parameters
doSwingAnimation
boolean = false
Whether the item should use the swing animation when thrown.
launchPowerScale
number = 1
The scale at which the power of the throw increases. Can be negative. Negative values will launch the projectile the opposite way.
maxDrawDuration
number = 0
The maximum duration to draw a throwable item. Can be negative. Will shoot instantly. No side effects if max is less than min from testing.
maxLaunchPower
number = 1
The maximum power to launch the throwable item. Can be negative.
minDrawDuration
number = 0
The minimum duration to draw a throwable item. Can be negative. Will shoot instantly.
scalePowerByDrawDuration
boolean = false
Whether or not the power of the throw increases with duration charged. When true, The longer you hold, the more power it will have when released.
Returns
useAnimation()
useAnimation(type): ItemAllows the item to use specific animations.
Parameters
type
Animation type.
Returns
useModifiers()
useModifiers(useDuration, movementModifier): ItemDefines the use modifiers for the item.
Parameters
useDuration
number
Use Duration is how long it takes to use the item.
movementModifier
number = 1
Movement modifier is the speed at which the actor will move while using the item.
Returns
wearable()
wearable(protection, slot): ItemDetermines where the item can be worn. If any non-hand slot is chosen, the max stack size is set to 1.
Parameters
protection
number
Protection value.
slot
Slot to be worn on.