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

Interface JavaConsumable.Builder

All Superinterfaces:

GenericBuilder<JavaConsumable>

Enclosing interface:

JavaConsumable

public static interface JavaConsumable.Builder
extends GenericBuilder<JavaConsumable>

Builder for the consumable component.

Since:

2.9.3

Method Summary

Modifier and Type	Method	Description
JavaConsumable.Builder	animation(@NonNull JavaConsumable.Animation animation)	Sets the animation to play when consuming the item.
JavaConsumable	build()	Creates the consumable component.
JavaConsumable.Builder	consumeSeconds(@org.checkerframework.checker.index.qual.Positive float consumeSeconds)	Sets the time in seconds that consumption takes.

Method Details

consumeSeconds

JavaConsumable.Builder consumeSeconds(@org.checkerframework.checker.index.qual.Positive float consumeSeconds)

Sets the time in seconds that consumption takes. This also determines the animation length.

Parameters:

consumeSeconds - the seconds it takes to consume the item

Returns:

this builder

Since:

2.9.3

See Also:

• JavaConsumable.consumeSeconds()

animation

JavaConsumable.Builder animation(@NonNull JavaConsumable.Animation animation)

Sets the animation to play when consuming the item. See JavaConsumable.Animation for more details - some animations do not work correctly.

Parameters:

animation - the animation to play

Returns:

this builder

Since:

2.9.3

See Also:

• JavaConsumable.animation()

build

JavaConsumable build()

Creates the consumable component.

Specified by:

build in interface GenericBuilder<JavaConsumable>

Returns:

the new component

Since:

2.9.3