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

Interface CustomItemDefinition.Builder

All Superinterfaces:

GenericBuilder<CustomItemDefinition>

All Known Subinterfaces:

NonVanillaCustomItemDefinition.Builder

Enclosing interface:

CustomItemDefinition

public static interface CustomItemDefinition.Builder
extends GenericBuilder<CustomItemDefinition>

The builder for the custom item definition.

Since:

2.9.3

Method Summary

Modifier and Type	Method	Description
CustomItemDefinition.Builder	bedrockOptions(@NonNull CustomItemBedrockOptions.Builder options)	Sets the Bedrock item options for this definition.
CustomItemDefinition	build()	Creates the custom item definition.
default <T> CustomItemDefinition.Builder	component(@NonNull ItemDataComponent<T> component, @NonNull GenericBuilder<T> builder)	Convenience method for component(ItemDataComponent, Object)
<T> CustomItemDefinition.Builder	component(@NonNull ItemDataComponent<T> component, @NonNull T value)	Sets data components that determine the item behavior.
CustomItemDefinition.Builder	displayName(@NonNull String displayName)	Sets the display name, as shown to the Bedrock client.
CustomItemDefinition.Builder	predicate(@NonNull MinecraftPredicate<? super ItemPredicateContext> predicate)	Adds a predicate that must match for Geyser to use this item definition.
CustomItemDefinition.Builder	predicateStrategy(@NonNull PredicateStrategy strategy)	Sets the predicate strategy that should be used for item definition matching.
CustomItemDefinition.Builder	priority(int priority)	Sets the priority of this definition, used for definition matching.
default CustomItemDefinition.Builder	removeComponent(@NonNull ItemDataComponent<?> component)	Convenience method for removeComponent(Identifier).
CustomItemDefinition.Builder	removeComponent(@NonNull Identifier component)	Indicates a removed item component that will not be present on the custom item despite existing on the vanilla item.

Method Details

displayName

CustomItemDefinition.Builder displayName(@NonNull String displayName)

Sets the display name, as shown to the Bedrock client. When not set, the display name will be derived from the Bedrock item identifier.

Parameters:

displayName - the display name to show for Bedrock clients.

Returns:

this builder

Since:

2.9.3

priority

CustomItemDefinition.Builder priority(int priority)

Sets the priority of this definition, used for definition matching.

Parameters:

priority - the priority

Returns:

this builder

Since:

2.9.3

See Also:

• CustomItemDefinition.priority()

bedrockOptions

CustomItemDefinition.Builder bedrockOptions(@NonNull CustomItemBedrockOptions.Builder options)

Sets the Bedrock item options for this definition. Those determine the icon seen on Bedrock edition, whether the item can be placed in the offhand slot, and other options.

Parameters:

options - the bedrock item options

Returns:

this builder

Since:

2.9.3

See Also:

• CustomItemBedrockOptions

predicate

CustomItemDefinition.Builder predicate(@NonNull MinecraftPredicate<? super ItemPredicateContext> predicate)

Adds a predicate that must match for Geyser to use this item definition. See CustomItemDefinition.predicates() for details.

Parameters:

predicate - a predicate that must match for this item to be used

Returns:

this builder

Since:

2.9.3

predicateStrategy

CustomItemDefinition.Builder predicateStrategy(@NonNull PredicateStrategy strategy)

Sets the predicate strategy that should be used for item definition matching.

Parameters:

strategy - the predicate strategy to use

Returns:

this builder

Since:

2.9.3

component

<T> CustomItemDefinition.Builder component(@NonNull ItemDataComponent<T> component,
 @NonNull T value)

Sets data components that determine the item behavior. These are assumed to also be present server-side on the Java server. See CustomItemDefinition.components() for more information.

Added data components cannot be removed using removeComponent(Identifier), and this method will throw when a component is added that was removed using the aforementioned method.

Type Parameters:

T - the value held by the component

Parameters:

component - the type of the component, found in JavaItemDataComponents

value - the value of the component

Returns:

this builder

Throws:

IllegalArgumentException - when the added component was removed using removeComponent(Identifier)

Since:

2.9.3

component

default <T> CustomItemDefinition.Builder component(@NonNull ItemDataComponent<T> component,
 @NonNull GenericBuilder<T> builder)

Convenience method for component(ItemDataComponent, Object)

Type Parameters:

T - the value held by the component

Parameters:

component - the type of the component - found in JavaItemDataComponents

builder - the builder of the component

Returns:

this builder

Throws:

IllegalArgumentException - when the added component was removed using removeComponent(Identifier)

Since:

2.9.3

See Also:

• component(ItemDataComponent, Object)

removeComponent

CustomItemDefinition.Builder removeComponent(@NonNull Identifier component)

Indicates a removed item component that will not be present on the custom item despite existing on the vanilla item. This must match server-side behavior, otherwise, issues will occur. See CustomItemDefinition.removedComponents() for more information.

Removed data components cannot be added again using component(ItemDataComponent, Object), and this method will throw when a component is removed that was added using the aforementioned method.

Parameters:

component - the identifier of the vanilla base component to remove

Returns:

this builder

Throws:

IllegalArgumentException - when the removed component was added using component(ItemDataComponent, Object)

Since:

2.9.3

removeComponent

default CustomItemDefinition.Builder removeComponent(@NonNull ItemDataComponent<?> component)

Convenience method for removeComponent(Identifier).

Parameters:

component - the component type to remove

Returns:

this builder

Throws:

IllegalArgumentException - when the removed component was added using component(ItemDataComponent, Object)

Since:

2.9.3

build

CustomItemDefinition build()

Creates the custom item definition.

Specified by:

build in interface GenericBuilder<CustomItemDefinition>

Returns:

the new custom item definition

Since:

2.9.3