Package org.geysermc.geyser.api.item.custom

Interface CustomItemOptions

public interface CustomItemOptions

This class represents the different ways you can register custom items

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CustomItemOptions.Builder

Method Summary

Modifier and Type	Method	Description
static CustomItemOptions.Builder	builder()
@NonNull OptionalInt	customModelData()	Gets the item's custom model data predicate.
@NonNull OptionalInt	damagePredicate()	Gets the item's damage predicate.
boolean	defaultItem()	Gets if this mapping should just translate to the default item.
default boolean	hasCustomItemOptions()	Checks if the item has at least one option set
@NonNull TriState	unbreakable()	Gets if the item should be unbreakable.

Method Details

unbreakable

@NonNull TriState unbreakable()

Gets if the item should be unbreakable.

Returns:

if the item should be unbreakable

customModelData

@NonNull OptionalInt customModelData()

Gets the item's custom model data predicate.

Returns:

the item's custom model data

damagePredicate

@NonNull OptionalInt damagePredicate()

Gets the item's damage predicate.

Returns:

the item's damage predicate

defaultItem

boolean defaultItem()

Gets if this mapping should just translate to the default item. This is used for the damage predicate of damaged 1 damage 0 that is required to allow the default item to exist.

Returns:

true if this mapping should just translate to the default item, false otherwise

hasCustomItemOptions

default boolean hasCustomItemOptions()

Checks if the item has at least one option set

Returns:

true if the item at least one options set

builder

static CustomItemOptions.Builder builder()