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

Interface NonVanillaCustomItemDefinition.Builder

All Superinterfaces:

CustomItemDefinition.Builder, GenericBuilder<CustomItemDefinition>

Enclosing interface:

NonVanillaCustomItemDefinition

public static interface NonVanillaCustomItemDefinition.Builder
extends CustomItemDefinition.Builder

Builder for non-vanilla custom item definitions.

Since:

2.9.3

Method Summary

Modifier and Type	Method	Description
NonVanillaCustomItemDefinition.Builder	bedrockOptions(@NonNull CustomItemBedrockOptions.Builder options)	Sets the Bedrock item options for this definition.
NonVanillaCustomItemDefinition	build()	Creates the non-vanilla custom item definition.
<T> NonVanillaCustomItemDefinition.Builder	component(@NonNull ItemDataComponent<T> component, @NonNull T value)	Sets data components that determine the item behavior.
NonVanillaCustomItemDefinition.Builder	displayName(@NonNull String displayName)	Sets the display name, as shown to the Bedrock client.
NonVanillaCustomItemDefinition.Builder	priority(int priority)	Sets the priority of this definition, used for definition matching.
NonVanillaCustomItemDefinition.Builder	translationString(@Nullable String translationString)	Sets the Java translation string of the item.

Methods inherited from interface org.geysermc.geyser.api.item.custom.v2.CustomItemDefinition.Builder

component, predicate, predicateStrategy, removeComponent, removeComponent

Method Details

displayName

NonVanillaCustomItemDefinition.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.

Specified by:

displayName in interface CustomItemDefinition.Builder

Parameters:

displayName - the display name to show for Bedrock clients.

Returns:

this builder

Since:

2.9.3

priority

NonVanillaCustomItemDefinition.Builder priority(int priority)

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

Specified by:

priority in interface CustomItemDefinition.Builder

Parameters:

priority - the priority

Returns:

this builder

Since:

2.9.3

See Also:

• CustomItemDefinition.priority()

bedrockOptions

NonVanillaCustomItemDefinition.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.

Specified by:

bedrockOptions in interface CustomItemDefinition.Builder

Parameters:

options - the bedrock item options

Returns:

this builder

Since:

2.9.3

See Also:

• CustomItemBedrockOptions

component

<T> NonVanillaCustomItemDefinition.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 CustomItemDefinition.Builder.removeComponent(Identifier), and this method will throw when a component is added that was removed using the aforementioned method.

Specified by:

component in interface CustomItemDefinition.Builder

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

Since:

2.9.3

translationString

NonVanillaCustomItemDefinition.Builder translationString(@Nullable String translationString)

Sets the Java translation string of the item.

Parameters:

translationString - the Java translation string of the item

Returns:

this builder

Since:

2.9.3

build

NonVanillaCustomItemDefinition build()

Creates the non-vanilla custom item definition.

Specified by:

build in interface CustomItemDefinition.Builder

Specified by:

build in interface GenericBuilder<CustomItemDefinition>

Returns:

the new non-vanilla custom item definition

Since:

2.9.3